Class: Aws::SageMaker::Types::DescribeTransformJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::DescribeTransformJobResponse

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_ml_job_arn ⇒ String

  The Amazon Resource Name (ARN) of the AutoML transform job.

• #batch_strategy ⇒ String

  Specifies the number of records to include in a mini-batch for an HTTP inference request.

• #creation_time ⇒ Time

  A timestamp that shows when the transform Job was created.

• #data_capture_config ⇒ Types::BatchDataCaptureConfig

  Configuration to control how SageMaker captures inference data.

• #data_processing ⇒ Types::DataProcessing

  The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output.

• #environment ⇒ Hash<String,String>

  The environment variables to set in the Docker container.

• #experiment_config ⇒ Types::ExperimentConfig

  Associates a SageMaker job as a trial component with an experiment and trial.

• #failure_reason ⇒ String

  If the transform job failed, ‘FailureReason` describes why it failed.

• #labeling_job_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

• #max_concurrent_transforms ⇒ Integer

  The maximum number of parallel requests on each instance node that can be launched in a transform job.

• #max_payload_in_mb ⇒ Integer

  The maximum payload size, in MB, used in the transform job.

• #model_client_config ⇒ Types::ModelClientConfig

  The timeout and maximum number of retries for processing a transform job invocation.

• #model_name ⇒ String

  The name of the model used in the transform job.

• #transform_end_time ⇒ Time

  Indicates when the transform job has been completed, or has stopped or failed.

• #transform_input ⇒ Types::TransformInput

  Describes the dataset to be transformed and the Amazon S3 location where it is stored.

• #transform_job_arn ⇒ String

  The Amazon Resource Name (ARN) of the transform job.

• #transform_job_name ⇒ String

  The name of the transform job.

• #transform_job_status ⇒ String

  The status of the transform job.

• #transform_output ⇒ Types::TransformOutput

  Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

• #transform_resources ⇒ Types::TransformResources

  Describes the resources, including ML instance types and ML instance count, to use for the transform job.

• #transform_start_time ⇒ Time

  Indicates when the transform job starts on ML instances.

Instance Attribute Details

#auto_ml_job_arn ⇒ String

The Amazon Resource Name (ARN) of the AutoML transform job.

Returns:

• (String)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#batch_strategy ⇒ String

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record ** is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set ‘SplitType` to `Line`, `RecordIO`, or `TFRecord`.

Returns:

• (String)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

A timestamp that shows when the transform Job was created.

Returns:

• (Time)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#data_capture_config ⇒ Types::BatchDataCaptureConfig

Configuration to control how SageMaker captures inference data.

Returns:

• (Types::BatchDataCaptureConfig)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#data_processing ⇒ Types::DataProcessing

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see [Associate Prediction Results with their Corresponding Input Records].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html

Returns:

• (Types::DataProcessing)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ Hash<String,String>

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

Returns:

• (Hash<String,String>)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_config ⇒ Types::ExperimentConfig

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

• CreateProcessingJob][1

• CreateTrainingJob][2

• CreateTransformJob][3

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html [2]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html [3]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html

Returns:

• (Types::ExperimentConfig)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If the transform job failed, ‘FailureReason` describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see [Log Amazon SageMaker Events with Amazon CloudWatch].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html

Returns:

• (String)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#labeling_job_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Returns:

• (String)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#max_concurrent_transforms ⇒ Integer

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

Returns:

• (Integer)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#max_payload_in_mb ⇒ Integer

The maximum payload size, in MB, used in the transform job.

Returns:

• (Integer)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_client_config ⇒ Types::ModelClientConfig

The timeout and maximum number of retries for processing a transform job invocation.

Returns:

• (Types::ModelClientConfig)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_name ⇒ String

The name of the model used in the transform job.

Returns:

• (String)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_end_time ⇒ Time

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of ‘TransformStartTime`.

Returns:

• (Time)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_input ⇒ Types::TransformInput

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

Returns:

• (Types::TransformInput)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_job_arn ⇒ String

The Amazon Resource Name (ARN) of the transform job.

Returns:

• (String)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_job_name ⇒ String

The name of the transform job.

Returns:

• (String)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_job_status ⇒ String

The status of the transform job. If the transform job failed, the reason is returned in the ‘FailureReason` field.

Returns:

• (String)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_output ⇒ Types::TransformOutput

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

Returns:

• (Types::TransformOutput)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_resources ⇒ Types::TransformResources

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Returns:

• (Types::TransformResources)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_start_time ⇒ Time

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of ‘TransformEndTime`.

Returns:

• (Time)

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

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :auto_ml_job_arn,
  :data_processing,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end