You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#batch_strategyString

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)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#creation_timeTime

A timestamp that shows when the transform Job was created.

Returns:

  • (Time)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#data_processingTypes::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.



5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#environmentHash<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>)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#failure_reasonString

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.

Returns:

  • (String)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#labeling_job_arnString

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

Returns:

  • (String)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#max_concurrent_transformsInteger

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)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#max_payload_in_mbInteger

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

Returns:

  • (Integer)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#model_nameString

The name of the model used in the transform job.

Returns:

  • (String)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#transform_end_timeTime

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)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#transform_inputTypes::TransformInput

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



5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#transform_job_arnString

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

Returns:

  • (String)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#transform_job_nameString

The name of the transform job.

Returns:

  • (String)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#transform_job_statusString

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

Returns:

  • (String)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#transform_outputTypes::TransformOutput

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



5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#transform_resourcesTypes::TransformResources

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



5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end

#transform_start_timeTime

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)


5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5058

class DescribeTransformJobResponse < Struct.new(
  :transform_job_name,
  :transform_job_arn,
  :transform_job_status,
  :failure_reason,
  :model_name,
  :max_concurrent_transforms,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :transform_resources,
  :creation_time,
  :transform_start_time,
  :transform_end_time,
  :labeling_job_arn,
  :data_processing)
  include Aws::Structure
end