Interface ISageMakerCreateTransformJobJsonataProps
Properties for creating an Amazon SageMaker transform job task using JSONata.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ISageMakerCreateTransformJobJsonataProps : ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptionsSyntax (vb)
Public Interface ISageMakerCreateTransformJobJsonataProps Inherits ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptionsRemarks
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.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
using Amazon.CDK.Interfaces.KMS;
var assign;
InstanceType instanceType;
IKeyRef keyRef;
var outputs;
Role role;
Size size;
TaskRole taskRole;
Timeout timeout;
var sageMakerCreateTransformJobJsonataProps = new SageMakerCreateTransformJobJsonataProps {
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,
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
MaxConcurrentTransforms = 123,
MaxPayload = size,
ModelClientOptions = new ModelClientOptions {
InvocationsMaxRetries = 123,
InvocationsTimeout = Duration.Minutes(30)
},
Outputs = outputs,
QueryLanguage = QueryLanguage.JSON_PATH,
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
}
};Synopsis
Properties
| BatchStrategy | Number of records to include in a mini-batch for an HTTP inference request. |
| Environment | Environment variables to set in the Docker container. |
| 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. |
| Role | Role for the Transform Job. |
| Tags | Tags to be applied to the train job. |
| 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. |
Properties
BatchStrategy
Number of records to include in a mini-batch for an HTTP inference request.
BatchStrategy? BatchStrategy { get; }Property Value
Remarks
Default: - No batch strategy
Environment
Environment variables to set in the Docker container.
IDictionary<string, string>? Environment { get; }Property Value
Remarks
Default: - No environment variables
MaxConcurrentTransforms
Maximum number of parallel requests that can be sent to each instance in a transform job.
double? MaxConcurrentTransforms { get; }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.
Size? MaxPayload { get; }Property Value
Remarks
Default: 6
ModelClientOptions
Configures the timeout and maximum number of retries for processing a transform job invocation.
IModelClientOptions? ModelClientOptions { get; }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.
string ModelName { get; }Property Value
Remarks
ExampleMetadata: fixture=_generated
Role
Role for the Transform Job.
IRole? Role { get; }Property Value
Remarks
Default: - A role is created with AmazonSageMakerFullAccess managed policy
Tags
Tags to be applied to the train job.
IDictionary<string, string>? Tags { get; }Property Value
Remarks
Default: - No tags
TransformInput
Dataset to be transformed and the Amazon S3 location where it is stored.
ITransformInput TransformInput { get; }Property Value
Remarks
ExampleMetadata: fixture=_generated
TransformJobName
Transform Job Name.
string TransformJobName { get; }Property Value
Remarks
ExampleMetadata: fixture=_generated
TransformOutput
S3 location where you want Amazon SageMaker to save the results from the transform job.
ITransformOutput TransformOutput { get; }Property Value
Remarks
ExampleMetadata: fixture=_generated
TransformResources
ML compute instances for the transform job.
ITransformResources? TransformResources { get; }Property Value
Remarks
Default: - 1 instance of type M4.XLarge