Amazon SageMaker
Developer Guide

DescribeTransformJob

Returns information about a transform job.

Request Syntax

{ "TransformJobName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

TransformJobName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

Response Syntax

{ "BatchStrategy": "string", "CreationTime": number, "Environment": { "string" : "string" }, "FailureReason": "string", "MaxConcurrentTransforms": number, "MaxPayloadInMB": number, "ModelName": "string", "TransformEndTime": number, "TransformInput": { "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "SplitType": "string" }, "TransformJobArn": "string", "TransformJobName": "string", "TransformJobStatus": "string", "TransformOutput": { "Accept": "string", "AssembleWith": "string", "KmsKeyId": "string", "S3OutputPath": "string" }, "TransformResources": { "InstanceCount": number, "InstanceType": "string", "VolumeKmsKeyId": "string" }, "TransformStartTime": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BatchStrategy

SingleRecord means only one record was used per a batch. MultiRecord means batches contained as many records that could possibly fit within the MaxPayloadInMB limit.

Type: String

Valid Values: MultiRecord | SingleRecord

CreationTime

A timestamp that shows when the transform Job was created.

Type: Timestamp

Environment

Type: String to string map

Key Length Constraints: Maximum length of 1024.

Key Pattern: [a-zA-Z_][a-zA-Z0-9_]*

Value Length Constraints: Maximum length of 10240.

FailureReason

If the transform job failed, the reason that it failed.

Type: String

Length Constraints: Maximum length of 1024.

MaxConcurrentTransforms

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

Type: Integer

Valid Range: Minimum value of 0.

MaxPayloadInMB

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

Type: Integer

Valid Range: Minimum value of 0.

ModelName

The name of the model used in the transform job.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

TransformEndTime

Indicates when the transform job is Completed, Stopped, or Failed. You are billed for the time interval between this time and the value of TransformStartTime.

Type: Timestamp

TransformInput

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

Type: TransformInput object

TransformJobArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:transform-job/.*

TransformJobName

The name of the transform job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

TransformJobStatus

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

Type: String

Valid Values: InProgress | Completed | Failed | Stopping | Stopped

TransformOutput

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

Type: TransformOutput object

TransformResources

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

Type: TransformResources object

TransformStartTime

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: