Interface SageMakerCreateTransformJobProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, TaskStateBaseProps
All Known Implementing Classes:
SageMakerCreateTransformJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.197Z") @Stability(Stable) public interface SageMakerCreateTransformJobProps extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps
Properties for creating an Amazon SageMaker transform job task.

Example:

 SageMakerCreateTransformJob.Builder.create(this, "Batch Inference")
         .transformJobName("MyTransformJob")
         .modelName("MyModelName")
         .modelClientOptions(ModelClientOptions.builder()
                 .invocationsMaxRetries(3) // default is 0
                 .invocationsTimeout(Duration.minutes(5))
                 .build())
         .transformInput(TransformInput.builder()
                 .transformDataSource(TransformDataSource.builder()
                         .s3DataSource(TransformS3DataSource.builder()
                                 .s3Uri("s3://inputbucket/train")
                                 .s3DataType(S3DataType.S3_PREFIX)
                                 .build())
                         .build())
                 .build())
         .transformOutput(TransformOutput.builder()
                 .s3OutputPath("s3://outputbucket/TransformJobOutputPath")
                 .build())
         .transformResources(TransformResources.builder()
                 .instanceCount(1)
                 .instanceType(InstanceType.of(InstanceClass.M4, InstanceSize.XLARGE))
                 .build())
         .build();
 
  • Method Details

    • getModelName

      @Stability(Stable) @NotNull String getModelName()
      Name of the model that you want to use for the transform job.
    • getTransformInput

      @Stability(Stable) @NotNull TransformInput getTransformInput()
      Dataset to be transformed and the Amazon S3 location where it is stored.
    • getTransformJobName

      @Stability(Stable) @NotNull String getTransformJobName()
      Transform Job Name.
    • getTransformOutput

      @Stability(Stable) @NotNull TransformOutput getTransformOutput()
      S3 location where you want Amazon SageMaker to save the results from the transform job.
    • getBatchStrategy

      @Stability(Stable) @Nullable default BatchStrategy getBatchStrategy()
      Number of records to include in a mini-batch for an HTTP inference request.

      Default: - No batch strategy

    • getEnvironment

      @Stability(Stable) @Nullable default Map<String,String> getEnvironment()
      Environment variables to set in the Docker container.

      Default: - No environment variables

    • getMaxConcurrentTransforms

      @Stability(Stable) @Nullable default Number getMaxConcurrentTransforms()
      Maximum number of parallel requests that can be sent to each instance in a transform job.

      Default: - Amazon 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.

    • getMaxPayload

      @Stability(Stable) @Nullable default Size getMaxPayload()
      Maximum allowed size of the payload, in MB.

      Default: 6

    • getModelClientOptions

      @Stability(Stable) @Nullable default ModelClientOptions getModelClientOptions()
      Configures the timeout and maximum number of retries for processing a transform job invocation.

      Default: - 0 retries and 60 seconds of timeout

    • getRole

      @Stability(Stable) @Nullable default IRole getRole()
      Role for the Transform Job.

      Default: - A role is created with `AmazonSageMakerFullAccess` managed policy

    • getTags

      @Stability(Stable) @Nullable default Map<String,String> getTags()
      Tags to be applied to the train job.

      Default: - No tags

    • getTransformResources

      @Stability(Stable) @Nullable default TransformResources getTransformResources()
      ML compute instances for the transform job.

      Default: - 1 instance of type M4.XLarge

    • builder

      @Stability(Stable) static SageMakerCreateTransformJobProps.Builder builder()
      Returns:
      a SageMakerCreateTransformJobProps.Builder of SageMakerCreateTransformJobProps