Documentation

A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.

See: newTransformJob smart constructor.

Create a value of TransformJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoMLJobArn:TransformJob', transformJob_autoMLJobArn - The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

$sel:batchStrategy:TransformJob', transformJob_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.

$sel:creationTime:TransformJob', transformJob_creationTime - A timestamp that shows when the transform Job was created.

$sel:dataProcessing:TransformJob', transformJob_dataProcessing - Undocumented member.

$sel:environment:TransformJob', transformJob_environment - The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

$sel:experimentConfig:TransformJob', transformJob_experimentConfig - Undocumented member.

$sel:failureReason:TransformJob', transformJob_failureReason - If the transform job failed, the reason it failed.

$sel:labelingJobArn:TransformJob', transformJob_labelingJobArn - The Amazon Resource Name (ARN) of the labeling job that created the transform job.

$sel:maxConcurrentTransforms:TransformJob', transformJob_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, 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 built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

$sel:maxPayloadInMB:TransformJob', transformJob_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. 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, SageMaker built-in algorithms do not support HTTP chunked encoding.

$sel:modelClientConfig:TransformJob', transformJob_modelClientConfig - Undocumented member.

$sel:modelName:TransformJob', transformJob_modelName - The name of the model associated with the transform job.

$sel:tags:TransformJob', transformJob_tags - A list of tags associated with the transform job.

$sel:transformEndTime:TransformJob', transformJob_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.

$sel:transformInput:TransformJob', transformJob_transformInput - Undocumented member.

$sel:transformJobArn:TransformJob', transformJob_transformJobArn - The Amazon Resource Name (ARN) of the transform job.

$sel:transformJobName:TransformJob', transformJob_transformJobName - The name of the transform job.

$sel:transformJobStatus:TransformJob', transformJob_transformJobStatus - The status of the transform job.

Transform job statuses are:

• InProgress - The job is in progress.
• Completed - The job has completed.
• Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
• Stopping - The transform job is stopping.
• Stopped - The transform job has stopped.

$sel:transformOutput:TransformJob', transformJob_transformOutput - Undocumented member.

$sel:transformResources:TransformJob', transformJob_transformResources - Undocumented member.

$sel:transformStartTime:TransformJob', transformJob_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.

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

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.

A timestamp that shows when the transform Job was created.

Undocumented member.

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

Undocumented member.

If the transform job failed, the reason it failed.

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

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, 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 built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

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. 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, SageMaker built-in algorithms do not support HTTP chunked encoding.

Undocumented member.

The name of the model associated with the transform job.

A list of tags associated with the transform job.

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.

Undocumented member.

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

The name of the transform job.

The status of the transform job.

Transform job statuses are:

• InProgress - The job is in progress.
• Completed - The job has completed.
• Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
• Stopping - The transform job is stopping.
• Stopped - The transform job has stopped.

Undocumented member.

Undocumented member.

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