AWS::SageMaker::TransformJob

SageMaker TransformJob

Resource type definition for AWS::SageMaker::TransformJob. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

Properties

13 configurable properties. 5 required. Click a row to see details.

Filter:

Property	Type	Flags
`ModelName`	`string`	RequiredCreate-only
`TransformInput`	`object`	RequiredCreate-only
`TransformOutput`	`object`	RequiredCreate-only
`TransformResources`	`object`	RequiredCreate-only
`BatchStrategy`	`string`	Create-only
`DataCaptureConfig`	`object`	Create-only
`DataProcessing`	`object`	Create-only
`Environment`	`object`	Create-only
`ExperimentConfig`	`object`	Create-only
`MaxConcurrentTransforms`	`integer`	Create-only
`MaxPayloadInMB`	`integer`	Create-only
`ModelClientConfig`	`object`	Create-only
`Tags`	`Array<object>`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`TransformJobName`	`string`	The name of the transform job. The name must be unique within an AWS Region in an AWS account.
`CreationTime`	`string`	A timestamp that shows when the transform job was created.
`TransformEndTime`	`string`	Indicates when the transform job has been completed, or has stopped or failed.
`TransformJobArn`	`string`	The Amazon Resource Name (ARN) of the transform job.
`TransformJobStatus`	`string`	The status of the transform job.
`TransformStartTime`	`string`	Indicates when the transform job starts on ML instances.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::SageMaker::TransformJob

Resources:
  MyResource:
    Type: AWS::SageMaker::TransformJob
    Properties:
      ModelName: "my-modelname"
      TransformInput: {}
      TransformOutput: {}
      TransformResources: {}
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

sagemaker:DescribeTransformJobsagemaker:ListTags

list

sagemaker:ListTransformJobs

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceSageMaker

Properties19

Required5

TaggingSupported

Primary IDTransformJobArn

Supported Operations

ReadList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

BatchStrategyDataCaptureConfigDataProcessingEnvironmentExperimentConfigMaxConcurrentTransformsMaxPayloadInMBModelClientConfigModelNameTagsTransformInputTransformOutputTransformResources

Related Resources

External Links

AWS Documentation