SageMakerCreateTransformJobJsonPathProps Struct
Properties for creating an Amazon SageMaker transform job task using JSONPath.
Example
// 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,
},
};
Properties
assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}#Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
batchStrategyBatchStrategybatch_strategyBatchStrategybatchStrategyBatchStrategyBatchStrategyBatchStrategyBatchStrategyBatchStrategy#Default: No batch strategy
Default: No comment
credentialsCredentialscredentialsCredentialscredentialsCredentialsCredentialsCredentialsCredentialsCredentials#Default: None (Task is executed using the State Machine's execution role)
This enables cross-account resource invocations.
environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*string#Default: No environment variables
heartbeatDurationheartbeatDurationheartbeatDurationHeartbeatDurationHeartbeatDuration= Nonedeprecated#heartbeatTimeoutTimeoutheartbeat_timeoutTimeoutheartbeatTimeoutTimeoutHeartbeatTimeoutTimeoutHeartbeatTimeoutTimeout= None#[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPatternIntegrationPatternintegration_patternIntegrationPatternintegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPattern#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.
maxConcurrentTransformsnumbermax_concurrent_transformsint | floatmaxConcurrentTransformsNumberMaxConcurrentTransformsdoubleMaxConcurrentTransforms*float64#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.
modelClientOptionsModelClientOptionsmodel_client_optionsModelClientOptionsmodelClientOptionsModelClientOptionsModelClientOptionsModelClientOptionsModelClientOptionsModelClientOptions#Default: 0 retries and 60 seconds of timeout
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= JSONPath#If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelector{ [key: string]: any }result_selectortyping.Mapping[str, Any]resultSelectorMap<String, Object>ResultSelectorIDictionary<string, object>ResultSelector*map[string]interface{}= None#You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: A role is created with AmazonSageMakerFullAccess managed policy
Default: The construct ID will be used as state name
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string#Default: No tags
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
transformInputTransformInputtransform_inputTransformInputtransformInputTransformInputTransformInputTransformInputTransformInputTransformInputrequired#transformJobNamestringtransform_job_namestrtransformJobNameStringTransformJobNamestringTransformJobName*stringrequired#transformOutputTransformOutputtransform_outputTransformOutputtransformOutputTransformOutputTransformOutputTransformOutputTransformOutputTransformOutputrequired#transformResourcesTransformResourcestransform_resourcesTransformResourcestransformResourcesTransformResourcesTransformResourcesTransformResourcesTransformResourcesTransformResources#Default: 1 instance of type M4.XLarge