Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Returns information about a transform job.

post/#X-Amz-Target=SageMaker.DescribeTransformJob

Headers

X-Amz-Target'SageMaker.DescribeTransformJob' required

Request body

TransformJobNamestring required

The name of the transform job that you want to view details of.

Response

Success

TransformJobNamestring required

The name of the transform job.

TransformJobArnstring required

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

TransformJobStatus'InProgress' | 'Completed' | 'Failed' | 'Stopping' | 'Stopped' required

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

FailureReasonstring

If the transform job failed, <code>FailureReason</code> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html">Log Amazon SageMaker Events with Amazon CloudWatch</a>.

ModelNamestring required

The name of the model used in the transform job.

MaxConcurrentTransformsinteger

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

MaxPayloadInMBinteger

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

BatchStrategy'MultiRecord' | 'SingleRecord'
<p>Specifies the number of records to include in a mini-batch for an HTTP inference request. A <i>record</i> <i/> 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. </p> <p>To enable the batch strategy, you must set <code>SplitType</code> to <code>Line</code>, <code>RecordIO</code>, or <code>TFRecord</code>.</p>
Environmentobject

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

CreationTimestring date-time required

A timestamp that shows when the transform Job was created.

TransformStartTimestring date-time

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of <code>TransformEndTime</code>.

TransformEndTimestring date-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 <code>TransformStartTime</code>.

LabelingJobArnstring

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

AutoMLJobArnstring

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