Class: Aws::SageMaker::Types::CreateTransformJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::CreateTransformJobRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #batch_strategy ⇒ String

  Specifies the number of records to include in a mini-batch for an HTTP inference request.

• #data_capture_config ⇒ Types::BatchDataCaptureConfig

  Configuration to control how SageMaker captures inference data.

• #data_processing ⇒ Types::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.

• #environment ⇒ Hash<String,String>

  The environment variables to set in the Docker container.

• #experiment_config ⇒ Types::ExperimentConfig

  Associates a SageMaker job as a trial component with an experiment and trial.

• #max_concurrent_transforms ⇒ Integer

  The maximum number of parallel requests that can be sent to each instance in a transform job.

• #max_payload_in_mb ⇒ Integer

  The maximum allowed size of the payload, in MB.

• #model_client_config ⇒ Types::ModelClientConfig

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

• #model_name ⇒ String

  The name of the model that you want to use for the transform job.

• #tags ⇒ Array<Types::Tag>

  (Optional) An array of key-value pairs.

• #transform_input ⇒ Types::TransformInput

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

• #transform_job_name ⇒ String

  The name of the transform job.

• #transform_output ⇒ Types::TransformOutput

  Describes the results of the transform job.

• #transform_resources ⇒ Types::TransformResources

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

Instance Attribute Details

#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`.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#data_capture_config ⇒ Types::BatchDataCaptureConfig

Configuration to control how SageMaker captures inference data.

Returns:

• (Types::BatchDataCaptureConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#data_processing ⇒ Types::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].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html

Returns:

• (Types::DataProcessing)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ Hash<String,String>

The environment variables to set in the Docker container. Don’t include any sensitive data in your environment variables. We support up to 16 key and values entries in the map.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_config ⇒ Types::ExperimentConfig

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:

• CreateProcessingJob][1

• CreateTrainingJob][2

• CreateTransformJob][3

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html [2]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html [3]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html

Returns:

• (Types::ExperimentConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#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`.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests

Returns:

• (Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#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.

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#model_client_config ⇒ Types::ModelClientConfig

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

Returns:

• (Types::ModelClientConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#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 Amazon Web Services Region in an Amazon Web Services account.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

(Optional) An array of key-value pairs. For more information, see

Using Cost Allocation Tags][1

in the *Amazon Web Services Billing

and Cost Management User Guide*.

[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_input ⇒ Types::TransformInput

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

Returns:

• (Types::TransformInput)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_job_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_output ⇒ Types::TransformOutput

Describes the results of the transform job.

Returns:

• (Types::TransformOutput)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end

#transform_resources ⇒ Types::TransformResources

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

Returns:

• (Types::TransformResources)

# File 'lib/aws-sdk-sagemaker/types.rb', line 10014

class CreateTransformJobRequest < Struct.new(
  :transform_job_name,
  :model_name,
  :max_concurrent_transforms,
  :model_client_config,
  :max_payload_in_mb,
  :batch_strategy,
  :environment,
  :transform_input,
  :transform_output,
  :data_capture_config,
  :transform_resources,
  :data_processing,
  :tags,
  :experiment_config)
  SENSITIVE = []
  include Aws::Structure
end