Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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]){0,62}

Required: Yes

Response Syntax


{
   "AutoMLJobArn": "string",
   "BatchStrategy": "string",
   "CreationTime": number,
   "DataCaptureConfig": { 
      "DestinationS3Uri": "string",
      "GenerateInferenceId": boolean,
      "KmsKeyId": "string"
   },
   "DataProcessing": { 
      "InputFilter": "string",
      "JoinSource": "string",
      "OutputFilter": "string"
   },
   "Environment": { 
      "string" : "string" 
   },
   "ExperimentConfig": { 
      "ExperimentName": "string",
      "RunName": "string",
      "TrialComponentDisplayName": "string",
      "TrialName": "string"
   },
   "FailureReason": "string",
   "LabelingJobArn": "string",
   "MaxConcurrentTransforms": number,
   "MaxPayloadInMB": number,
   "ModelClientConfig": { 
      "InvocationsMaxRetries": number,
      "InvocationsTimeoutInSeconds": 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.

AutoMLJobArn

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

Type: String

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

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

BatchStrategy

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.

Type: String

Valid Values: MultiRecord | SingleRecord

CreationTime

A timestamp that shows when the transform Job was created.

Type: Timestamp

DataCaptureConfig

Configuration to control how SageMaker captures inference data.

Type: BatchDataCaptureConfig object

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.

Type: DataProcessing object

Environment

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

Type: String to string map

Map Entries: Maximum number of 16 items.

Key Length Constraints: Maximum length of 1024.

Key Pattern: [a-zA-Z_][a-zA-Z0-9_]{0,1023}

Value Length Constraints: Maximum length of 10240.

Value Pattern: [\S\s]*

ExperimentConfig

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

Type: ExperimentConfig object

FailureReason

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.

Type: String

Length Constraints: Maximum length of 1024.

LabelingJobArn

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

Type: String

Length Constraints: Maximum length of 2048.

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

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.

ModelClientConfig

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

Type: ModelClientConfig object

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]*[a-zA-Z0-9])?

TransformEndTime

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.

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]){0,62}

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