Skip to content
v2.277.0

SageMakerCreateTransformJobJsonPathProps Struct ​

Properties for creating an Amazon SageMaker transform job task using JSONPath.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';
import { aws_kms as interfaces_kms } from 'aws-cdk-lib/interfaces';

declare const assign: any;
declare const instanceType: ec2.InstanceType;
declare const keyRef: interfaces_kms.IKeyRef;
declare const resultSelector: any;
declare const role: iam.Role;
declare const size: cdk.Size;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const sageMakerCreateTransformJobJsonPathProps: stepfunctions_tasks.SageMakerCreateTransformJobJsonPathProps = {
  modelName: 'modelName',
  transformInput: {
    transformDataSource: {
      s3DataSource: {
        s3Uri: 's3Uri',

        // the properties below are optional
        s3DataType: stepfunctions_tasks.S3DataType.MANIFEST_FILE,
      },
    },

    // the properties below are optional
    compressionType: stepfunctions_tasks.CompressionType.NONE,
    contentType: 'contentType',
    splitType: stepfunctions_tasks.SplitType.NONE,
  },
  transformJobName: 'transformJobName',
  transformOutput: {
    s3OutputPath: 's3OutputPath',

    // the properties below are optional
    accept: 'accept',
    assembleWith: stepfunctions_tasks.AssembleWith.NONE,
    encryptionKey: keyRef,
  },

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  batchStrategy: stepfunctions_tasks.BatchStrategy.MULTI_RECORD,
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  environment: {
    environmentKey: 'environment',
  },
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  maxConcurrentTransforms: 123,
  maxPayload: size,
  modelClientOptions: {
    invocationsMaxRetries: 123,
    invocationsTimeout: cdk.Duration.minutes(30),
  },
  outputPath: 'outputPath',
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  role: role,
  stateName: 'stateName',
  tags: {
    tagsKey: 'tags',
  },
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
  transformResources: {
    instanceCount: 123,
    instanceType: instanceType,

    // the properties below are optional
    volumeEncryptionKey: keyRef,
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_iam as iam
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks
from aws_cdk.interfaces import aws_kms as interfaces_kms

# assign: Any
# instance_type: ec2.InstanceType
# key_ref: interfaces_kms.IKeyRef
# result_selector: Any
# role: iam.Role
# size: cdk.Size
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

sage_maker_create_transform_job_json_path_props = stepfunctions_tasks.SageMakerCreateTransformJobJsonPathProps(
    model_name="modelName",
    transform_input=stepfunctions_tasks.TransformInput(
        transform_data_source=stepfunctions_tasks.TransformDataSource(
            s3_data_source=stepfunctions_tasks.TransformS3DataSource(
                s3_uri="s3Uri",

                # the properties below are optional
                s3_data_type=stepfunctions_tasks.S3DataType.MANIFEST_FILE
            )
        ),

        # the properties below are optional
        compression_type=stepfunctions_tasks.CompressionType.NONE,
        content_type="contentType",
        split_type=stepfunctions_tasks.SplitType.NONE
    ),
    transform_job_name="transformJobName",
    transform_output=stepfunctions_tasks.TransformOutput(
        s3_output_path="s3OutputPath",

        # the properties below are optional
        accept="accept",
        assemble_with=stepfunctions_tasks.AssembleWith.NONE,
        encryption_key=key_ref
    ),

    # the properties below are optional
    assign={
        "assign_key": assign
    },
    batch_strategy=stepfunctions_tasks.BatchStrategy.MULTI_RECORD,
    comment="comment",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    environment={
        "environment_key": "environment"
    },
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    input_path="inputPath",
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    max_concurrent_transforms=123,
    max_payload=size,
    model_client_options=stepfunctions_tasks.ModelClientOptions(
        invocations_max_retries=123,
        invocations_timeout=cdk.Duration.minutes(30)
    ),
    output_path="outputPath",
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    result_path="resultPath",
    result_selector={
        "result_selector_key": result_selector
    },
    role=role,
    state_name="stateName",
    tags={
        "tags_key": "tags"
    },
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30),
    transform_resources=stepfunctions_tasks.TransformResources(
        instance_count=123,
        instance_type=instance_type,

        # the properties below are optional
        volume_encryption_key=key_ref
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
import software.amazon.awscdk.interfaces.kms.*;

Object assign;
InstanceType instanceType;
IKeyRef keyRef;
Object resultSelector;
Role role;
Size size;
TaskRole taskRole;
Timeout timeout;

SageMakerCreateTransformJobJsonPathProps sageMakerCreateTransformJobJsonPathProps = SageMakerCreateTransformJobJsonPathProps.builder()
        .modelName("modelName")
        .transformInput(TransformInput.builder()
                .transformDataSource(TransformDataSource.builder()
                        .s3DataSource(TransformS3DataSource.builder()
                                .s3Uri("s3Uri")

                                // the properties below are optional
                                .s3DataType(S3DataType.MANIFEST_FILE)
                                .build())
                        .build())

                // the properties below are optional
                .compressionType(CompressionType.NONE)
                .contentType("contentType")
                .splitType(SplitType.NONE)
                .build())
        .transformJobName("transformJobName")
        .transformOutput(TransformOutput.builder()
                .s3OutputPath("s3OutputPath")

                // the properties below are optional
                .accept("accept")
                .assembleWith(AssembleWith.NONE)
                .encryptionKey(keyRef)
                .build())

        // the properties below are optional
        .assign(Map.of(
                "assignKey", assign))
        .batchStrategy(BatchStrategy.MULTI_RECORD)
        .comment("comment")
        .credentials(Credentials.builder()
                .role(taskRole)
                .build())
        .environment(Map.of(
                "environmentKey", "environment"))
        .heartbeat(Duration.minutes(30))
        .heartbeatTimeout(timeout)
        .inputPath("inputPath")
        .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
        .maxConcurrentTransforms(123)
        .maxPayload(size)
        .modelClientOptions(ModelClientOptions.builder()
                .invocationsMaxRetries(123)
                .invocationsTimeout(Duration.minutes(30))
                .build())
        .outputPath("outputPath")
        .queryLanguage(QueryLanguage.JSON_PATH)
        .resultPath("resultPath")
        .resultSelector(Map.of(
                "resultSelectorKey", resultSelector))
        .role(role)
        .stateName("stateName")
        .tags(Map.of(
                "tagsKey", "tags"))
        .taskTimeout(timeout)
        .timeout(Duration.minutes(30))
        .transformResources(TransformResources.builder()
                .instanceCount(123)
                .instanceType(instanceType)

                // the properties below are optional
                .volumeEncryptionKey(keyRef)
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
using Amazon.CDK.Interfaces.KMS;

var assign;
InstanceType instanceType;
IKeyRef keyRef;
var resultSelector;
Role role;
Size size;
TaskRole taskRole;
Timeout timeout;

var sageMakerCreateTransformJobJsonPathProps = new SageMakerCreateTransformJobJsonPathProps {
    ModelName = "modelName",
    TransformInput = new TransformInput {
        TransformDataSource = new TransformDataSource {
            S3DataSource = new TransformS3DataSource {
                S3Uri = "s3Uri",

                // the properties below are optional
                S3DataType = S3DataType.MANIFEST_FILE
            }
        },

        // the properties below are optional
        CompressionType = CompressionType.NONE,
        ContentType = "contentType",
        SplitType = SplitType.NONE
    },
    TransformJobName = "transformJobName",
    TransformOutput = new TransformOutput {
        S3OutputPath = "s3OutputPath",

        // the properties below are optional
        Accept = "accept",
        AssembleWith = AssembleWith.NONE,
        EncryptionKey = keyRef
    },

    // the properties below are optional
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    BatchStrategy = BatchStrategy.MULTI_RECORD,
    Comment = "comment",
    Credentials = new Credentials {
        Role = taskRole
    },
    Environment = new Dictionary<string, string> {
        { "environmentKey", "environment" }
    },
    Heartbeat = Duration.Minutes(30),
    HeartbeatTimeout = timeout,
    InputPath = "inputPath",
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    MaxConcurrentTransforms = 123,
    MaxPayload = size,
    ModelClientOptions = new ModelClientOptions {
        InvocationsMaxRetries = 123,
        InvocationsTimeout = Duration.Minutes(30)
    },
    OutputPath = "outputPath",
    QueryLanguage = QueryLanguage.JSON_PATH,
    ResultPath = "resultPath",
    ResultSelector = new Dictionary<string, object> {
        { "resultSelectorKey", resultSelector }
    },
    Role = role,
    StateName = "stateName",
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    },
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30),
    TransformResources = new TransformResources {
        InstanceCount = 123,
        InstanceType = instanceType,

        // the properties below are optional
        VolumeEncryptionKey = keyRef
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assign interface{}
var instanceType InstanceType
var keyRef IKeyRef
var resultSelector interface{}
var role Role
var size Size
var taskRole TaskRole
var timeout Timeout

sageMakerCreateTransformJobJsonPathProps := &SageMakerCreateTransformJobJsonPathProps{
	ModelName: jsii.String("modelName"),
	TransformInput: &TransformInput{
		TransformDataSource: &TransformDataSource{
			S3DataSource: &TransformS3DataSource{
				S3Uri: jsii.String("s3Uri"),

				// the properties below are optional
				S3DataType: awscdk.Aws_stepfunctions_tasks.S3DataType_MANIFEST_FILE,
			},
		},

		// the properties below are optional
		CompressionType: awscdk.*Aws_stepfunctions_tasks.CompressionType_NONE,
		ContentType: jsii.String("contentType"),
		SplitType: awscdk.*Aws_stepfunctions_tasks.SplitType_NONE,
	},
	TransformJobName: jsii.String("transformJobName"),
	TransformOutput: &TransformOutput{
		S3OutputPath: jsii.String("s3OutputPath"),

		// the properties below are optional
		Accept: jsii.String("accept"),
		AssembleWith: awscdk.*Aws_stepfunctions_tasks.AssembleWith_NONE,
		EncryptionKey: keyRef,
	},

	// the properties below are optional
	Assign: map[string]interface{}{
		"assignKey": assign,
	},
	BatchStrategy: awscdk.*Aws_stepfunctions_tasks.BatchStrategy_MULTI_RECORD,
	Comment: jsii.String("comment"),
	Credentials: &Credentials{
		Role: taskRole,
	},
	Environment: map[string]*string{
		"environmentKey": jsii.String("environment"),
	},
	Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
	HeartbeatTimeout: timeout,
	InputPath: jsii.String("inputPath"),
	IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
	MaxConcurrentTransforms: jsii.Number(123),
	MaxPayload: size,
	ModelClientOptions: &ModelClientOptions{
		InvocationsMaxRetries: jsii.Number(123),
		InvocationsTimeout: cdk.Duration_*Minutes(jsii.Number(30)),
	},
	OutputPath: jsii.String("outputPath"),
	QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
	ResultPath: jsii.String("resultPath"),
	ResultSelector: map[string]interface{}{
		"resultSelectorKey": resultSelector,
	},
	Role: role,
	StateName: jsii.String("stateName"),
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
	TaskTimeout: timeout,
	Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
	TransformResources: &TransformResources{
		InstanceCount: jsii.Number(123),
		InstanceType: instanceType,

		// the properties below are optional
		VolumeEncryptionKey: keyRef,
	},
}

Properties ​

assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#
Workflow variables to store in this step.

Default: Not assign variables

Using workflow variables, you can store data in a step and retrieve that data in future steps.

batchStrategyoptionalBatchStrategybatch_strategyoptionalBatchStrategybatchStrategyoptionalBatchStrategyBatchStrategyoptionalBatchStrategyBatchStrategyoptionalBatchStrategy#
Number of records to include in a mini-batch for an HTTP inference request.

Default: No batch strategy

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#
A comment describing this state.

Default: No comment

credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#
Credentials for an IAM Role that the State Machine assumes for executing the task.

Default: None (Task is executed using the State Machine's execution role)

This enables cross-account resource invocations.

environmentoptional{ [key: string]: string }environmentoptionaltyping.Mapping[str, str]environmentoptionalMap<String, String>EnvironmentoptionalIDictionary<string, string>Environmentoptional*map[string]*string#
Environment variables to set in the Docker container.

Default: No environment variables

heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#
use `heartbeatTimeout`
heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout= None#
Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string= $#
JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern#
AWS Step Functions integrates with services directly in the Amazon States Language.

Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

maxConcurrentTransformsoptionalnumbermax_concurrent_transformsoptionalint | floatmaxConcurrentTransformsoptionalNumberMaxConcurrentTransformsoptionaldoubleMaxConcurrentTransformsoptional*float64#
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.

maxPayloadoptionalSizemax_payloadoptionalSizemaxPayloadoptionalSizeMaxPayloadoptionalSizeMaxPayloadoptionalSize= 6#
Maximum allowed size of the payload, in MB.
modelClientOptionsoptionalModelClientOptionsmodel_client_optionsoptionalModelClientOptionsmodelClientOptionsoptionalModelClientOptionsModelClientOptionsoptionalModelClientOptionsModelClientOptionsoptionalModelClientOptions#
Configures the timeout and maximum number of retries for processing a transform job invocation.

Default: 0 retries and 60 seconds of timeout

modelNamestringmodel_namestrmodelNameStringModelNamestringModelName*stringrequired#
Name of the model that you want to use for the transform job.
outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string= $#
JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSONPath#
The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string= $#
JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{}= None#
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole#
Role for the Transform Job.

Default: A role is created with AmazonSageMakerFullAccess managed policy

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#
Optional name for this state.

Default: The construct ID will be used as state name

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
Tags to be applied to the train job.

Default: No tags

taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout= None#
Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Nonedeprecated#
use `taskTimeout`
transformInputTransformInputtransform_inputTransformInputtransformInputTransformInputTransformInputTransformInputTransformInputTransformInputrequired#
Dataset to be transformed and the Amazon S3 location where it is stored.
transformJobNamestringtransform_job_namestrtransformJobNameStringTransformJobNamestringTransformJobName*stringrequired#
Transform Job Name.
transformOutputTransformOutputtransform_outputTransformOutputtransformOutputTransformOutputTransformOutputTransformOutputTransformOutputTransformOutputrequired#
S3 location where you want Amazon SageMaker to save the results from the transform job.
transformResourcesoptionalTransformResourcestransform_resourcesoptionalTransformResourcestransformResourcesoptionalTransformResourcesTransformResourcesoptionalTransformResourcesTransformResourcesoptionalTransformResources#
ML compute instances for the transform job.

Default: 1 instance of type M4.XLarge