AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateTransformJob operation. Starts a transform job. 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.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

For more information about how batch transformation works, see Batch Transform.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.CreateTransformJobRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class CreateTransformJobRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The CreateTransformJobRequest type exposes the following members

Constructors

NameDescription
Public Method CreateTransformJobRequest()

Properties

NameTypeDescription
Public Property BatchStrategy Amazon.SageMaker.BatchStrategy

Gets and sets the property 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 the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

Public Property DataCaptureConfig Amazon.SageMaker.Model.BatchDataCaptureConfig

Gets and sets the property DataCaptureConfig.

Configuration to control how SageMaker captures inference data.

Public Property DataProcessing Amazon.SageMaker.Model.DataProcessing

Gets and sets the property 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.

Public Property Environment System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Environment.

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

Public Property ExperimentConfig Amazon.SageMaker.Model.ExperimentConfig

Gets and sets the property ExperimentConfig.

Public Property MaxConcurrentTransforms System.Int32

Gets and sets the property MaxConcurrentTransforms.

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, 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. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

Public Property MaxPayloadInMB System.Int32

Gets and sets the property MaxPayloadInMB.

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

Public Property ModelClientConfig Amazon.SageMaker.Model.ModelClientConfig

Gets and sets the property ModelClientConfig.

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

Public Property ModelName System.String

Gets and sets the property ModelName.

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

Public Property Tags System.Collections.Generic.List<Amazon.SageMaker.Model.Tag>

Gets and sets the property Tags.

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

Public Property TransformInput Amazon.SageMaker.Model.TransformInput

Gets and sets the property TransformInput.

Describes the input source and the way the transform job consumes it.

Public Property TransformJobName System.String

Gets and sets the property TransformJobName.

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

Public Property TransformOutput Amazon.SageMaker.Model.TransformOutput

Gets and sets the property TransformOutput.

Describes the results of the transform job.

Public Property TransformResources Amazon.SageMaker.Model.TransformResources

Gets and sets the property TransformResources.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5