Class SageMakerCreateTransformJobJsonPathProps
Properties for creating an Amazon SageMaker transform job task using JSONPath.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SageMakerCreateTransformJobJsonPathProps : ISageMakerCreateTransformJobJsonPathProps, ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptionsSyntax (vb)
Public Class SageMakerCreateTransformJobJsonPathProps Implements ISageMakerCreateTransformJobJsonPathProps, ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptionsRemarks
ExampleMetadata: fixture=_generated
Examples
// 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.KMS;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
var assign;
InstanceType instanceType;
Key key;
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 = key
},
// 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 = key
}
};Synopsis
Constructors
| SageMakerCreateTransformJobJsonPathProps() | Properties for creating an Amazon SageMaker transform job task using JSONPath. |
Properties
| Assign | Workflow variables to store in this step. |
| BatchStrategy | Number of records to include in a mini-batch for an HTTP inference request. |
| Comment | A comment describing this state. |
| Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
| Environment | Environment variables to set in the Docker container. |
| Heartbeat | (deprecated) Timeout for the heartbeat. |
| HeartbeatTimeout | Timeout for the heartbeat. |
| InputPath | JSONPath expression to select part of the state to be the input to this state. |
| IntegrationPattern | AWS Step Functions integrates with services directly in the Amazon States Language. |
| MaxConcurrentTransforms | Maximum number of parallel requests that can be sent to each instance in a transform job. |
| MaxPayload | Maximum allowed size of the payload, in MB. |
| ModelClientOptions | Configures the timeout and maximum number of retries for processing a transform job invocation. |
| ModelName | Name of the model that you want to use for the transform job. |
| OutputPath | JSONPath expression to select part of the state to be the output to this state. |
| QueryLanguage | The name of the query language used by the state. |
| ResultPath | JSONPath expression to indicate where to inject the state's output. |
| ResultSelector | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
| Role | Role for the Transform Job. |
| StateName | Optional name for this state. |
| Tags | Tags to be applied to the train job. |
| TaskTimeout | Timeout for the task. |
| Timeout | (deprecated) Timeout for the task. |
| TransformInput | Dataset to be transformed and the Amazon S3 location where it is stored. |
| TransformJobName | Transform Job Name. |
| TransformOutput | S3 location where you want Amazon SageMaker to save the results from the transform job. |
| TransformResources | ML compute instances for the transform job. |
Constructors
SageMakerCreateTransformJobJsonPathProps()
Properties for creating an Amazon SageMaker transform job task using JSONPath.
public SageMakerCreateTransformJobJsonPathProps()Remarks
ExampleMetadata: fixture=_generated
Examples
// 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.KMS;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
var assign;
InstanceType instanceType;
Key key;
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 = key
},
// 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 = key
}
};Properties
Assign
Workflow variables to store in this step.
public IDictionary<string, object>? Assign { get; set; }Property Value
Remarks
Using workflow variables, you can store data in a step and retrieve that data in future steps.
Default: - Not assign variables
See: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html
BatchStrategy
Number of records to include in a mini-batch for an HTTP inference request.
public BatchStrategy? BatchStrategy { get; set; }Property Value
Remarks
Default: - No batch strategy
Comment
A comment describing this state.
public string? Comment { get; set; }Property Value
Remarks
Default: No comment
Credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.
public ICredentials? Credentials { get; set; }Property Value
Remarks
This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
Environment
Environment variables to set in the Docker container.
public IDictionary<string, string>? Environment { get; set; }Property Value
Remarks
Default: - No environment variables
Heartbeat
(deprecated) Timeout for the heartbeat.
[Obsolete("use `heartbeatTimeout`")]
public Duration? Heartbeat { get; set; }Property Value
Remarks
Default: - None
Stability: Deprecated
HeartbeatTimeout
Timeout for the heartbeat.
public Timeout? HeartbeatTimeout { get; set; }Property Value
Remarks
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
InputPath
JSONPath expression to select part of the state to be the input to this state.
public string? InputPath { get; set; }Property Value
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: $
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public IntegrationPattern? IntegrationPattern { get; set; }Property Value
Remarks
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks.
IntegrationPattern.RUN_JOB for the following exceptions:
BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
MaxConcurrentTransforms
Maximum number of parallel requests that can be sent to each instance in a transform job.
public double? MaxConcurrentTransforms { get; set; }Property Value
Remarks
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.
MaxPayload
Maximum allowed size of the payload, in MB.
public Size? MaxPayload { get; set; }Property Value
Remarks
Default: 6
ModelClientOptions
Configures the timeout and maximum number of retries for processing a transform job invocation.
public IModelClientOptions? ModelClientOptions { get; set; }Property Value
Remarks
Default: - 0 retries and 60 seconds of timeout
ModelName
Name of the model that you want to use for the transform job.
public string ModelName { get; set; }Property Value
Remarks
ExampleMetadata: fixture=_generated
OutputPath
JSONPath expression to select part of the state to be the output to this state.
public string? OutputPath { get; set; }Property Value
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: $
QueryLanguage
The name of the query language used by the state.
public QueryLanguage? QueryLanguage { get; set; }Property Value
Remarks
If the state does not contain a queryLanguage field,
then it will use the query language specified in the top-level queryLanguage field.
Default: - JSONPath
ResultPath
JSONPath expression to indicate where to inject the state's output.
public string? ResultPath { get; set; }Property Value
Remarks
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: $
ResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
public IDictionary<string, object>? ResultSelector { get; set; }Property Value
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
Role
Role for the Transform Job.
public IRole? Role { get; set; }Property Value
Remarks
Default: - A role is created with AmazonSageMakerFullAccess managed policy
StateName
Optional name for this state.
public string? StateName { get; set; }Property Value
Remarks
Default: - The construct ID will be used as state name
Tags
Tags to be applied to the train job.
public IDictionary<string, string>? Tags { get; set; }Property Value
Remarks
Default: - No tags
TaskTimeout
Timeout for the task.
public Timeout? TaskTimeout { get; set; }Property Value
Remarks
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
Timeout
(deprecated) Timeout for the task.
[Obsolete("use `taskTimeout`")]
public Duration? Timeout { get; set; }Property Value
Remarks
Default: - None
Stability: Deprecated
TransformInput
Dataset to be transformed and the Amazon S3 location where it is stored.
public ITransformInput TransformInput { get; set; }Property Value
Remarks
ExampleMetadata: fixture=_generated
TransformJobName
Transform Job Name.
public string TransformJobName { get; set; }Property Value
Remarks
ExampleMetadata: fixture=_generated
TransformOutput
S3 location where you want Amazon SageMaker to save the results from the transform job.
public ITransformOutput TransformOutput { get; set; }Property Value
Remarks
ExampleMetadata: fixture=_generated
TransformResources
ML compute instances for the transform job.
public ITransformResources? TransformResources { get; set; }Property Value
Remarks
Default: - 1 instance of type M4.XLarge