Class: Aws::SageMaker::Types::TransformJob

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

Overview

A batch transform job. For information about SageMaker batch transform, see [Use Batch Transform].

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_ml_job_arnString

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

Returns:

  • (String)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

A timestamp that shows when the transform Job was created.

Returns:

  • (Time)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_capture_configTypes::BatchDataCaptureConfig

Configuration to control how SageMaker captures inference data for batch transform jobs.



43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  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].

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



43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  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>)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_configTypes::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



43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reasonString

If the transform job failed, the reason it failed.

Returns:

  • (String)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#labeling_job_arnString

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

Returns:

  • (String)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#max_concurrent_transformsInteger

The maximum number of parallel requests that can be sent to each instance in a transform job. If ‘MaxConcurrentTransforms` is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is

  1. For built-in algorithms, you don’t need to set a value for

‘MaxConcurrentTransforms`.

Returns:

  • (Integer)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#max_payload_in_mbInteger

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in ‘MaxPayloadInMB` must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

Returns:

  • (Integer)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_client_configTypes::ModelClientConfig

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



43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_nameString

The name of the model associated with the transform job.

Returns:

  • (String)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags associated with the transform job.

Returns:



43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  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)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#transform_inputTypes::TransformInput

Describes the input source of a transform job and the way the transform job consumes it.



43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#transform_job_arnString

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

Returns:

  • (String)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#transform_job_nameString

The name of the transform job.

Returns:

  • (String)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#transform_job_statusString

The status of the transform job.

Transform job statuses are:

  • ‘InProgress` - The job is in progress.

  • ‘Completed` - The job has completed.

  • ‘Failed` - The transform job has failed. To see the reason for the failure, see the `FailureReason` field in the response to a `DescribeTransformJob` call.

  • ‘Stopping` - The transform job is stopping.

  • ‘Stopped` - The transform job has stopped.

Returns:

  • (String)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#transform_outputTypes::TransformOutput

Describes the results of a transform job.



43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#transform_resourcesTypes::TransformResources

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



43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  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)


43931
43932
43933
43934
43935
43936
43937
43938
43939
43940
43941
43942
43943
43944
43945
43946
43947
43948
43949
43950
43951
43952
43953
43954
43955
43956
# File 'lib/aws-sdk-sagemaker/types.rb', line 43931

class TransformJob < 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,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end