class SageMakerCreateTrainingJob (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.SageMakerCreateTrainingJob |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#SageMakerCreateTrainingJob |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateTrainingJob |
![]() | aws_cdk.aws_stepfunctions_tasks.SageMakerCreateTrainingJob |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » SageMakerCreateTrainingJob |
Implements
IConstruct
, IDependable
, IChainable
, INextable
, IGrantable
, IConnectable
Class representing the SageMaker Create Training Job task.
Example
new tasks.SageMakerCreateTrainingJob(this, 'TrainSagemaker', {
trainingJobName: sfn.JsonPath.stringAt('$.JobName'),
algorithmSpecification: {
algorithmName: 'BlazingText',
trainingInputMode: tasks.InputMode.FILE,
},
inputDataConfig: [{
channelName: 'train',
dataSource: {
s3DataSource: {
s3DataType: tasks.S3DataType.S3_PREFIX,
s3Location: tasks.S3Location.fromJsonExpression('$.S3Bucket'),
},
},
}],
outputDataConfig: {
s3OutputLocation: tasks.S3Location.fromBucket(s3.Bucket.fromBucketName(this, 'Bucket', 'amzn-s3-demo-bucket'), 'myoutputpath'),
},
resourceConfig: {
instanceCount: 1,
instanceType: new ec2.InstanceType(sfn.JsonPath.stringAt('$.InstanceType')),
volumeSize: Size.gibibytes(50),
}, // optional: default is 1 instance of EC2 `M4.XLarge` with `10GB` volume
stoppingCondition: {
maxRuntime: Duration.hours(2),
}, // optional: default is 1 hour
});
Initializer
new SageMakerCreateTrainingJob(scope: Construct, id: string, props: SageMakerCreateTrainingJobProps)
Parameters
- scope
Construct
- id
string
— Descriptive identifier for this chainable. - props
Sage
Maker Create Training Job Props
Construct Props
Name | Type | Description |
---|---|---|
algorithm | Algorithm | Identifies the training algorithm to use. |
output | Output | Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training. |
training | string | Training Job Name. |
assign? | { [string]: any } | Workflow variables to store in this step. |
comment? | string | A comment describing this state. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
enable | boolean | Isolates the training container. |
environment? | { [string]: string } | Environment variables to set in the Docker container. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
hyperparameters? | { [string]: any } | Algorithm-specific parameters that influence the quality of the model. |
input | Channel [] | Describes the various datasets (e.g. train, validation, test) and the Amazon S3 location where stored. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
output | string | JSONPath expression to select part of the state to be the output to this state. |
outputs? | any | Used to specify and transform output from the state. |
query | Query | The name of the query language used by the state. |
resource | Resource | Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
role? | IRole | Role for the Training Job. |
state | string | Optional name for this state. |
stopping | Stopping | Sets a time limit for training. |
tags? | { [string]: string } | Tags to be applied to the train job. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
vpc | Vpc | Specifies the VPC that you want your training job to connect to. |
algorithmSpecification
Type:
Algorithm
Identifies the training algorithm to use.
outputDataConfig
Type:
Output
Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training.
trainingJobName
Type:
string
Training Job Name.
assign?
Type:
{ [string]: any }
(optional, default: Not assign variables)
Workflow variables to store in this step.
Using workflow variables, you can store data in a step and retrieve that data in future steps.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html
comment?
Type:
string
(optional, default: No comment)
A comment describing this state.
credentials?
Type:
Credentials
(optional, default: None (Task is executed using the State Machine's execution role))
Credentials for an IAM Role that the State Machine assumes for executing the task.
This enables cross-account resource invocations.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
enableNetworkIsolation?
Type:
boolean
(optional, default: false)
Isolates the training container.
No inbound or outbound network calls can be made to or from the training container.
environment?
Type:
{ [string]: string }
(optional, default: No environment variables)
Environment variables to set in the Docker container.
heartbeat?
⚠️ Deprecated: use heartbeatTimeout
Type:
Duration
(optional, default: None)
Timeout for the heartbeat.
heartbeatTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
hyperparameters?
Type:
{ [string]: any }
(optional, default: No hyperparameters)
Algorithm-specific parameters that influence the quality of the model.
Set hyperparameters before you start the learning process. For a list of hyperparameters provided by Amazon SageMaker
See also: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html
inputDataConfig?
Type:
Channel
[]
(optional, default: No inputDataConfig)
Describes the various datasets (e.g. train, validation, test) and the Amazon S3 location where stored.
inputPath?
Type:
string
(optional, default: $)
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 {}.
integrationPattern?
Type:
Integration
(optional, default: IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.)
AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
outputPath?
Type:
string
(optional, default: $)
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 {}.
outputs?
Type:
any
(optional, default: $states.result or $states.errorOutput)
Used to specify and transform output from the state.
When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html
queryLanguage?
Type:
Query
(optional, default: 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.
resourceConfig?
Type:
Resource
(optional, default: 1 instance of EC2 M4.XLarge
with 10GB
volume)
Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.
resultPath?
Type:
string
(optional, default: $)
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.
resultSelector?
Type:
{ [string]: any }
(optional, default: 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.
role?
Type:
IRole
(optional, default: a role will be created.)
Role for the Training Job.
The role must be granted all necessary permissions for the SageMaker training job to be able to operate.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.
stoppingCondition?
Type:
Stopping
(optional, default: max runtime of 1 hour)
Sets a time limit for training.
tags?
Type:
{ [string]: string }
(optional, default: No tags)
Tags to be applied to the train job.
taskTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeout?
⚠️ Deprecated: use taskTimeout
Type:
Duration
(optional, default: None)
Timeout for the task.
vpcConfig?
Type:
Vpc
(optional, default: No VPC)
Specifies the VPC that you want your training job to connect to.
Properties
Name | Type | Description |
---|---|---|
connections | Connections | Allows specify security group connections for instances of this fleet. |
end | INextable [] | Continuable states of this Chainable. |
grant | IPrincipal | The principal to grant permissions to. |
id | string | Descriptive identifier for this chainable. |
node | Node | The tree node. |
role | IRole | The execution role for the Sagemaker training job. |
start | State | First state of this Chainable. |
state | string | Tokenized string that evaluates to the state's ID. |
task | Task | |
task | Policy [] |
connections
Type:
Connections
Allows specify security group connections for instances of this fleet.
endStates
Type:
INextable
[]
Continuable states of this Chainable.
grantPrincipal
Type:
IPrincipal
The principal to grant permissions to.
id
Type:
string
Descriptive identifier for this chainable.
node
Type:
Node
The tree node.
role
Type:
IRole
The execution role for the Sagemaker training job.
Only available after task has been added to a state machine.
startState
Type:
State
First state of this Chainable.
stateId
Type:
string
Tokenized string that evaluates to the state's ID.
taskMetrics?
Type:
Task
(optional)
taskPolicies?
Type:
Policy
[]
(optional)
Methods
Name | Description |
---|---|
add | Add a recovery handler for this state. |
add | Add a prefix to the stateId of this state. |
add | Add retry configuration for this state. |
add | Add the security group to all instances via the launch configuration security groups array. |
bind | Register this state as part of the given graph. |
metric(metricName, props?) | Return the given named metric for this Task. |
metric | Metric for the number of times this activity fails. |
metric | Metric for the number of times the heartbeat times out for this activity. |
metric | The interval, in milliseconds, between the time the Task starts and the time it closes. |
metric | The interval, in milliseconds, for which the activity stays in the schedule state. |
metric | Metric for the number of times this activity is scheduled. |
metric | Metric for the number of times this activity is started. |
metric | Metric for the number of times this activity succeeds. |
metric | The interval, in milliseconds, between the time the activity is scheduled and the time it closes. |
metric | Metric for the number of times this activity times out. |
next(next) | Continue normal execution with the given state. |
to | Return the Amazon States Language object for this state. |
to | Returns a string representation of this construct. |
static json | A Step Functions Task using JSONPath to create a SageMaker training job. |
static jsonata(scope, id, props) | A Step Functions Task using JSONata to create a SageMaker training job. |
addCatch(handler, props?)
public addCatch(handler: IChainable, props?: CatchProps): TaskStateBase
Parameters
- handler
IChainable
- props
Catch
Props
Returns
Add a recovery handler for this state.
When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.
addPrefix(x)
public addPrefix(x: string): void
Parameters
- x
string
Add a prefix to the stateId of this state.
addRetry(props?)
public addRetry(props?: RetryProps): TaskStateBase
Parameters
- props
Retry
Props
Returns
Add retry configuration for this state.
This controls if and how the execution will be retried if a particular error occurs.
addSecurityGroup(securityGroup)
public addSecurityGroup(securityGroup: ISecurityGroup): void
Parameters
- securityGroup
ISecurity
— : The security group to add.Group
Add the security group to all instances via the launch configuration security groups array.
bindToGraph(graph)
public bindToGraph(graph: StateGraph): void
Parameters
- graph
State
Graph
Register this state as part of the given graph.
Don't call this. It will be called automatically when you work with states normally.
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Return the given named metric for this Task.
metricFailed(props?)
public metricFailed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity fails.
metricHeartbeatTimedOut(props?)
public metricHeartbeatTimedOut(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times the heartbeat times out for this activity.
metricRunTime(props?)
public metricRunTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, between the time the Task starts and the time it closes.
metricScheduleTime(props?)
public metricScheduleTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, for which the activity stays in the schedule state.
metricScheduled(props?)
public metricScheduled(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity is scheduled.
metricStarted(props?)
public metricStarted(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity is started.
metricSucceeded(props?)
public metricSucceeded(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity succeeds.
metricTime(props?)
public metricTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
metricTimedOut(props?)
public metricTimedOut(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity times out.
next(next)
public next(next: IChainable): Chain
Parameters
- next
IChainable
Returns
Continue normal execution with the given state.
toStateJson(topLevelQueryLanguage?)
public toStateJson(topLevelQueryLanguage?: QueryLanguage): json
Parameters
- topLevelQueryLanguage
Query
Language
Returns
json
Return the Amazon States Language object for this state.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static jsonPath(scope, id, props)
public static jsonPath(scope: Construct, id: string, props: SageMakerCreateTrainingJobJsonPathProps): SageMakerCreateTrainingJob
Parameters
- scope
Construct
- id
string
- props
Sage
Maker Create Training Job Json Path Props
Returns
A Step Functions Task using JSONPath to create a SageMaker training job.
static jsonata(scope, id, props)
public static jsonata(scope: Construct, id: string, props: SageMakerCreateTrainingJobJsonataProps): SageMakerCreateTrainingJob
Parameters
- scope
Construct
- id
string
- props
Sage
Maker Create Training Job Jsonata Props
Returns
A Step Functions Task using JSONata to create a SageMaker training job.