Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

create-transform-job

Description

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:

  • TransformJobName - Identifies the transform job. The name must be unique within an AWS Region in an AWS account.
  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see CreateModel .
  • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
  • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
  • TransformResources - Identifies the ML compute instances for the transform job.

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-transform-job
--transform-job-name <value>
--model-name <value>
[--max-concurrent-transforms <value>]
[--max-payload-in-mb <value>]
[--batch-strategy <value>]
[--environment <value>]
--transform-input <value>
--transform-output <value>
--transform-resources <value>
[--data-processing <value>]
[--tags <value>]
[--experiment-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--transform-job-name (string)

The name of the transform job. The name must be unique within an AWS Region in an AWS account.

--model-name (string)

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 AWS Region in an AWS account.

--max-concurrent-transforms (integer)

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 .

--max-payload-in-mb (integer)

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

--batch-strategy (string)

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 .

Possible values:

  • MultiRecord
  • SingleRecord

--environment (map)

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

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--transform-input (structure)

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

Shorthand Syntax:

DataSource={S3DataSource={S3DataType=string,S3Uri=string}},ContentType=string,CompressionType=string,SplitType=string

JSON Syntax:

{
  "DataSource": {
    "S3DataSource": {
      "S3DataType": "ManifestFile"|"S3Prefix"|"AugmentedManifestFile",
      "S3Uri": "string"
    }
  },
  "ContentType": "string",
  "CompressionType": "None"|"Gzip",
  "SplitType": "None"|"Line"|"RecordIO"|"TFRecord"
}

--transform-output (structure)

Describes the results of the transform job.

Shorthand Syntax:

S3OutputPath=string,Accept=string,AssembleWith=string,KmsKeyId=string

JSON Syntax:

{
  "S3OutputPath": "string",
  "Accept": "string",
  "AssembleWith": "None"|"Line",
  "KmsKeyId": "string"
}

--transform-resources (structure)

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

Shorthand Syntax:

InstanceType=string,InstanceCount=integer,VolumeKmsKeyId=string

JSON Syntax:

{
  "InstanceType": "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge",
  "InstanceCount": integer,
  "VolumeKmsKeyId": "string"
}

--data-processing (structure)

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 .

Shorthand Syntax:

InputFilter=string,OutputFilter=string,JoinSource=string

JSON Syntax:

{
  "InputFilter": "string",
  "OutputFilter": "string",
  "JoinSource": "Input"|"None"
}

--tags (list)

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

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--experiment-config (structure)

Configuration for the experiment.

Shorthand Syntax:

ExperimentName=string,TrialName=string,TrialComponentDisplayName=string

JSON Syntax:

{
  "ExperimentName": "string",
  "TrialName": "string",
  "TrialComponentDisplayName": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

TransformJobArn -> (string)

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