Categorygithub.com/aws/aws-cdk-go/awscdk/v2awsstepfunctionstasks

package

2.166.0

Repository: https://github.com/aws/aws-cdk-go.git

Documentation: pkg.go.dev

# README

Tasks for AWS Step Functions

AWS Step Functions is a web service that enables you to coordinate the components of distributed applications and microservices using visual workflows. You build applications from individual components that each perform a discrete function, or task, allowing you to scale and change applications quickly.

A Task state represents a single unit of work performed by a state machine. All work in your state machine is performed by tasks. This module contains a collection of classes that allow you to call various AWS services from your Step Functions state machine.

Be sure to familiarize yourself with the aws-stepfunctions module documentation first.

This module is part of the AWS Cloud Development Kit project.

Tasks for AWS Step Functions

Paths

Learn more about input and output processing in Step Functions here

Evaluate Expression

Use the EvaluateExpression to perform simple operations referencing state paths. The expression referenced in the task will be evaluated in a Lambda function (eval()). This allows you to not have to write Lambda code for simple operations.

Example: convert a wait time from milliseconds to seconds, concat this in a message and wait:

convertToSeconds := tasks.NewEvaluateExpression(this, jsii.String("Convert to seconds"), &EvaluateExpressionProps{
	Expression: jsii.String("$.waitMilliseconds / 1000"),
	ResultPath: jsii.String("$.waitSeconds"),
})

createMessage := tasks.NewEvaluateExpression(this, jsii.String("Create message"), &EvaluateExpressionProps{
	// Note: this is a string inside a string.
	Expression: jsii.String("`Now waiting ${$.waitSeconds} seconds...`"),
	Runtime: lambda.Runtime_NODEJS_LATEST(),
	ResultPath: jsii.String("$.message"),
})

publishMessage := tasks.NewSnsPublish(this, jsii.String("Publish message"), &SnsPublishProps{
	Topic: sns.NewTopic(this, jsii.String("cool-topic")),
	Message: sfn.TaskInput_FromJsonPathAt(jsii.String("$.message")),
	ResultPath: jsii.String("$.sns"),
})

wait := sfn.NewWait(this, jsii.String("Wait"), &WaitProps{
	Time: sfn.WaitTime_SecondsPath(jsii.String("$.waitSeconds")),
})

sfn.NewStateMachine(this, jsii.String("StateMachine"), &StateMachineProps{
	Definition: convertToSeconds.Next(createMessage).Next(publishMessage).*Next(wait),
})

The EvaluateExpression supports a runtime prop to specify the Lambda runtime to use to evaluate the expression. Currently, only runtimes of the Node.js family are supported.

API Gateway

Step Functions supports API Gateway through the service integration pattern.

HTTP APIs are designed for low-latency, cost-effective integrations with AWS services, including AWS Lambda, and HTTP endpoints. HTTP APIs support OIDC and OAuth 2.0 authorization, and come with built-in support for CORS and automatic deployments. Previous-generation REST APIs currently offer more features. More details can be found here.

Call REST API Endpoint

The CallApiGatewayRestApiEndpoint calls the REST API endpoint.

import apigateway "github.com/aws/aws-cdk-go/awscdk"

restApi := apigateway.NewRestApi(this, jsii.String("MyRestApi"))

invokeTask := tasks.NewCallApiGatewayRestApiEndpoint(this, jsii.String("Call REST API"), &CallApiGatewayRestApiEndpointProps{
	Api: restApi,
	StageName: jsii.String("prod"),
	Method: tasks.HttpMethod_GET,
})

Be aware that the header values must be arrays. When passing the Task Token in the headers field WAIT_FOR_TASK_TOKEN integration, use JsonPath.array() to wrap the token in an array:

import apigateway "github.com/aws/aws-cdk-go/awscdk"
var api restApi


tasks.NewCallApiGatewayRestApiEndpoint(this, jsii.String("Endpoint"), &CallApiGatewayRestApiEndpointProps{
	Api: Api,
	StageName: jsii.String("Stage"),
	Method: tasks.HttpMethod_PUT,
	IntegrationPattern: sfn.IntegrationPattern_WAIT_FOR_TASK_TOKEN,
	Headers: sfn.TaskInput_FromObject(map[string]interface{}{
		"TaskToken": sfn.JsonPath_array(sfn.JsonPath_taskToken()),
	}),
})

Call HTTP API Endpoint

The CallApiGatewayHttpApiEndpoint calls the HTTP API endpoint.

import apigatewayv2 "github.com/aws/aws-cdk-go/awscdk"

httpApi := apigatewayv2.NewHttpApi(this, jsii.String("MyHttpApi"))

invokeTask := tasks.NewCallApiGatewayHttpApiEndpoint(this, jsii.String("Call HTTP API"), &CallApiGatewayHttpApiEndpointProps{
	ApiId: httpApi.ApiId,
	ApiStack: awscdk.*stack_Of(httpApi),
	Method: tasks.HttpMethod_GET,
})

AWS SDK

Step Functions supports calling AWS service's API actions through the service integration pattern.

You can use Step Functions' AWS SDK integrations to call any of the over two hundred AWS services directly from your state machine, giving you access to over nine thousand API actions.

var myBucket bucket

getObject := tasks.NewCallAwsService(this, jsii.String("GetObject"), &CallAwsServiceProps{
	Service: jsii.String("s3"),
	Action: jsii.String("getObject"),
	Parameters: map[string]interface{}{
		"Bucket": myBucket.bucketName,
		"Key": sfn.JsonPath_stringAt(jsii.String("$.key")),
	},
	IamResources: []*string{
		myBucket.ArnForObjects(jsii.String("*")),
	},
})

Use camelCase for actions and PascalCase for parameter names.

The task automatically adds an IAM statement to the state machine role's policy based on the service and action called. The resources for this statement must be specified in iamResources.

Use the iamAction prop to manually specify the IAM action name in the case where the IAM action name does not match with the API service/action name:

listBuckets := tasks.NewCallAwsService(this, jsii.String("ListBuckets"), &CallAwsServiceProps{
	Service: jsii.String("s3"),
	Action: jsii.String("listBuckets"),
	IamResources: []*string{
		jsii.String("*"),
	},
	IamAction: jsii.String("s3:ListAllMyBuckets"),
})

Use the additionalIamStatements prop to pass additional IAM statements that will be added to the state machine role's policy. Use it in the case where the call requires more than a single statement to be executed:

detectLabels := tasks.NewCallAwsService(this, jsii.String("DetectLabels"), &CallAwsServiceProps{
	Service: jsii.String("rekognition"),
	Action: jsii.String("detectLabels"),
	IamResources: []*string{
		jsii.String("*"),
	},
	AdditionalIamStatements: []policyStatement{
		iam.NewPolicyStatement(&PolicyStatementProps{
			Actions: []*string{
				jsii.String("s3:getObject"),
			},
			Resources: []*string{
				jsii.String("arn:aws:s3:::amzn-s3-demo-bucket/*"),
			},
		}),
	},
})

Cross-region AWS API call

You can call AWS API in a different region from your state machine by using the CallAwsServiceCrossRegion construct. In addition to the properties for CallAwsService construct, you have to set region property to call the API.

var myBucket bucket

getObject := tasks.NewCallAwsServiceCrossRegion(this, jsii.String("GetObject"), &CallAwsServiceCrossRegionProps{
	Region: jsii.String("ap-northeast-1"),
	Service: jsii.String("s3"),
	Action: jsii.String("getObject"),
	Parameters: map[string]interface{}{
		"Bucket": myBucket.bucketName,
		"Key": sfn.JsonPath_stringAt(jsii.String("$.key")),
	},
	IamResources: []*string{
		myBucket.ArnForObjects(jsii.String("*")),
	},
})

Other properties such as additionalIamStatements can be used in the same way as the CallAwsService task.

Athena

Step Functions supports Athena through the service integration pattern.

StartQueryExecution

The StartQueryExecution API runs the SQL query statement.

startQueryExecutionJob := tasks.NewAthenaStartQueryExecution(this, jsii.String("Start Athena Query"), &AthenaStartQueryExecutionProps{
	QueryString: sfn.JsonPath_StringAt(jsii.String("$.queryString")),
	QueryExecutionContext: &QueryExecutionContext{
		DatabaseName: jsii.String("mydatabase"),
	},
	ResultConfiguration: &ResultConfiguration{
		EncryptionConfiguration: &EncryptionConfiguration{
			EncryptionOption: tasks.EncryptionOption_S3_MANAGED,
		},
		OutputLocation: &Location{
			BucketName: jsii.String("amzn-s3-demo-bucket"),
			ObjectKey: jsii.String("folder"),
		},
	},
	ExecutionParameters: []*string{
		jsii.String("param1"),
		jsii.String("param2"),
	},
})

You can reuse the query results by setting the resultReuseConfigurationMaxAge property.

startQueryExecutionJob := tasks.NewAthenaStartQueryExecution(this, jsii.String("Start Athena Query"), &AthenaStartQueryExecutionProps{
	QueryString: sfn.JsonPath_StringAt(jsii.String("$.queryString")),
	QueryExecutionContext: &QueryExecutionContext{
		DatabaseName: jsii.String("mydatabase"),
	},
	ResultConfiguration: &ResultConfiguration{
		EncryptionConfiguration: &EncryptionConfiguration{
			EncryptionOption: tasks.EncryptionOption_S3_MANAGED,
		},
		OutputLocation: &Location{
			BucketName: jsii.String("query-results-bucket"),
			ObjectKey: jsii.String("folder"),
		},
	},
	ExecutionParameters: []*string{
		jsii.String("param1"),
		jsii.String("param2"),
	},
	ResultReuseConfigurationMaxAge: awscdk.Duration_Minutes(jsii.Number(100)),
})

GetQueryExecution

The GetQueryExecution API gets information about a single execution of a query.

getQueryExecutionJob := tasks.NewAthenaGetQueryExecution(this, jsii.String("Get Query Execution"), &AthenaGetQueryExecutionProps{
	QueryExecutionId: sfn.JsonPath_StringAt(jsii.String("$.QueryExecutionId")),
})

GetQueryResults

The GetQueryResults API that streams the results of a single query execution specified by QueryExecutionId from S3.

getQueryResultsJob := tasks.NewAthenaGetQueryResults(this, jsii.String("Get Query Results"), &AthenaGetQueryResultsProps{
	QueryExecutionId: sfn.JsonPath_StringAt(jsii.String("$.QueryExecutionId")),
})

StopQueryExecution

The StopQueryExecution API that stops a query execution.

stopQueryExecutionJob := tasks.NewAthenaStopQueryExecution(this, jsii.String("Stop Query Execution"), &AthenaStopQueryExecutionProps{
	QueryExecutionId: sfn.JsonPath_StringAt(jsii.String("$.QueryExecutionId")),
})

Batch

Step Functions supports Batch through the service integration pattern.

SubmitJob

The SubmitJob API submits an AWS Batch job from a job definition.

import batch "github.com/aws/aws-cdk-go/awscdk"
var batchJobDefinition ecsJobDefinition
var batchQueue jobQueue


task := tasks.NewBatchSubmitJob(this, jsii.String("Submit Job"), &BatchSubmitJobProps{
	JobDefinitionArn: batchJobDefinition.JobDefinitionArn,
	JobName: jsii.String("MyJob"),
	JobQueueArn: batchQueue.JobQueueArn,
})

Bedrock

Step Functions supports Bedrock through the service integration pattern.

InvokeModel

The InvokeModel API invokes the specified Bedrock model to run inference using the input provided. The format of the input body and the response body depend on the model selected.

import "github.com/aws/aws-cdk-go/awscdk"


model := bedrock.FoundationModel_FromFoundationModelId(this, jsii.String("Model"), bedrock.FoundationModelIdentifier_AMAZON_TITAN_TEXT_G1_EXPRESS_V1())

task := tasks.NewBedrockInvokeModel(this, jsii.String("Prompt Model"), &BedrockInvokeModelProps{
	Model: Model,
	Body: sfn.TaskInput_FromObject(map[string]interface{}{
		"inputText": jsii.String("Generate a list of five first names."),
		"textGenerationConfig": map[string]*f64{
			"maxTokenCount": jsii.Number(100),
			"temperature": jsii.Number(1),
		},
	}),
	ResultSelector: map[string]interface{}{
		"names": sfn.JsonPath_stringAt(jsii.String("$.Body.results[0].outputText")),
	},
})

Using Input Path for S3 URI

Provide S3 URI as an input or output path to invoke a model

To specify the S3 URI as JSON path to your input or output fields, use props s3InputUri and s3OutputUri under BedrockInvokeModelProps and set feature flag @aws-cdk/aws-stepfunctions-tasks:useNewS3UriParametersForBedrockInvokeModelTask to true.

If this flag is not enabled, the code will populate the S3Uri using InputPath and OutputPath fields, which is not recommended.

import "github.com/aws/aws-cdk-go/awscdk"


model := bedrock.FoundationModel_FromFoundationModelId(this, jsii.String("Model"), bedrock.FoundationModelIdentifier_AMAZON_TITAN_TEXT_G1_EXPRESS_V1())

task := tasks.NewBedrockInvokeModel(this, jsii.String("Prompt Model"), &BedrockInvokeModelProps{
	Model: Model,
	Input: &BedrockInvokeModelInputProps{
		S3InputUri: sfn.JsonPath_StringAt(jsii.String("$.prompt")),
	},
	Output: &BedrockInvokeModelOutputProps{
		S3OutputUri: sfn.JsonPath_*StringAt(jsii.String("$.prompt")),
	},
})

Using Input Path

Provide S3 URI as an input or output path to invoke a model

Currently, input and output Path provided in the BedrockInvokeModelProps input is defined as S3URI field under task definition of state machine. To modify the existing behaviour, set @aws-cdk/aws-stepfunctions-tasks:useNewS3UriParametersForBedrockInvokeModelTask to true.

If this feature flag is enabled, S3URI fields will be generated from other Props(s3InputUri and s3OutputUri), and the given inputPath, OutputPath will be rendered as it is in the JSON task definition.

If the feature flag is set to false, the behavior will be to populate the S3Uri using the InputPath and OutputPath fields, which is not recommended.

import "github.com/aws/aws-cdk-go/awscdk"


model := bedrock.FoundationModel_FromFoundationModelId(this, jsii.String("Model"), bedrock.FoundationModelIdentifier_AMAZON_TITAN_TEXT_G1_EXPRESS_V1())

task := tasks.NewBedrockInvokeModel(this, jsii.String("Prompt Model"), &BedrockInvokeModelProps{
	Model: Model,
	InputPath: sfn.JsonPath_StringAt(jsii.String("$.prompt")),
	OutputPath: sfn.JsonPath_*StringAt(jsii.String("$.prompt")),
})

You can apply a guardrail to the invocation by setting guardrail.

import "github.com/aws/aws-cdk-go/awscdk"


model := bedrock.FoundationModel_FromFoundationModelId(this, jsii.String("Model"), bedrock.FoundationModelIdentifier_AMAZON_TITAN_TEXT_G1_EXPRESS_V1())

task := tasks.NewBedrockInvokeModel(this, jsii.String("Prompt Model with guardrail"), &BedrockInvokeModelProps{
	Model: Model,
	Body: sfn.TaskInput_FromObject(map[string]interface{}{
		"inputText": jsii.String("Generate a list of five first names."),
		"textGenerationConfig": map[string]*f64{
			"maxTokenCount": jsii.Number(100),
			"temperature": jsii.Number(1),
		},
	}),
	Guardrail: tasks.Guardrail_Enable(jsii.String("guardrailId"), jsii.Number(1)),
	ResultSelector: map[string]interface{}{
		"names": sfn.JsonPath_stringAt(jsii.String("$.Body.results[0].outputText")),
	},
})

CodeBuild

Step Functions supports CodeBuild through the service integration pattern.

StartBuild

StartBuild starts a CodeBuild Project by Project Name.

import "github.com/aws/aws-cdk-go/awscdk"


codebuildProject := codebuild.NewProject(this, jsii.String("Project"), &ProjectProps{
	ProjectName: jsii.String("MyTestProject"),
	BuildSpec: codebuild.BuildSpec_FromObject(map[string]interface{}{
		"version": jsii.String("0.2"),
		"phases": map[string]map[string][]*string{
			"build": map[string][]*string{
				"commands": []*string{
					jsii.String("echo \"Hello, CodeBuild!\""),
				},
			},
		},
	}),
})

task := tasks.NewCodeBuildStartBuild(this, jsii.String("Task"), &CodeBuildStartBuildProps{
	Project: codebuildProject,
	IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
	EnvironmentVariablesOverride: map[string]buildEnvironmentVariable{
		"ZONE": &buildEnvironmentVariable{
			"type": codebuild.BuildEnvironmentVariableType_PLAINTEXT,
			"value": sfn.JsonPath_stringAt(jsii.String("$.envVariables.zone")),
		},
	},
})

StartBuildBatch

StartBuildBatch starts a batch CodeBuild for a project by project name. It is necessary to enable the batch build feature in the CodeBuild project.

import "github.com/aws/aws-cdk-go/awscdk"


project := codebuild.NewProject(this, jsii.String("Project"), &ProjectProps{
	ProjectName: jsii.String("MyTestProject"),
	BuildSpec: codebuild.BuildSpec_FromObjectToYaml(map[string]interface{}{
		"version": jsii.Number(0.2),
		"batch": map[string][]map[string]*string{
			"build-list": []map[string]*string{
				map[string]*string{
					"identifier": jsii.String("id"),
					"buildspec": jsii.String("version: 0.2\nphases:\n  build:\n    commands:\n      - echo \"Hello, from small!\""),
				},
			},
		},
	}),
})
project.EnableBatchBuilds()

task := tasks.NewCodeBuildStartBuildBatch(this, jsii.String("buildBatchTask"), &CodeBuildStartBuildBatchProps{
	Project: Project,
	IntegrationPattern: sfn.IntegrationPattern_REQUEST_RESPONSE,
	EnvironmentVariablesOverride: map[string]buildEnvironmentVariable{
		"test": &buildEnvironmentVariable{
			"type": codebuild.BuildEnvironmentVariableType_PLAINTEXT,
			"value": jsii.String("testValue"),
		},
	},
})

Note: enableBatchBuilds() will do nothing for imported projects. If you are using an imported project, you must ensure that the project is already configured for batch builds.

DynamoDB

You can call DynamoDB APIs from a Task state. Read more about calling DynamoDB APIs here

GetItem

The GetItem operation returns a set of attributes for the item with the given primary key.

var myTable table

tasks.NewDynamoGetItem(this, jsii.String("Get Item"), &DynamoGetItemProps{
	Key: map[string]dynamoAttributeValue{
		"messageId": tasks.*dynamoAttributeValue_fromString(jsii.String("message-007")),
	},
	Table: myTable,
})

PutItem

The PutItem operation creates a new item, or replaces an old item with a new item.

var myTable table

tasks.NewDynamoPutItem(this, jsii.String("PutItem"), &DynamoPutItemProps{
	Item: map[string]dynamoAttributeValue{
		"MessageId": tasks.*dynamoAttributeValue_fromString(jsii.String("message-007")),
		"Text": tasks.*dynamoAttributeValue_fromString(sfn.JsonPath_stringAt(jsii.String("$.bar"))),
		"TotalCount": tasks.*dynamoAttributeValue_fromNumber(jsii.Number(10)),
	},
	Table: myTable,
})

DeleteItem

The DeleteItem operation deletes a single item in a table by primary key.

var myTable table

tasks.NewDynamoDeleteItem(this, jsii.String("DeleteItem"), &DynamoDeleteItemProps{
	Key: map[string]dynamoAttributeValue{
		"MessageId": tasks.*dynamoAttributeValue_fromString(jsii.String("message-007")),
	},
	Table: myTable,
	ResultPath: sfn.JsonPath_DISCARD(),
})

UpdateItem

The UpdateItem operation edits an existing item's attributes, or adds a new item to the table if it does not already exist.

var myTable table

tasks.NewDynamoUpdateItem(this, jsii.String("UpdateItem"), &DynamoUpdateItemProps{
	Key: map[string]dynamoAttributeValue{
		"MessageId": tasks.*dynamoAttributeValue_fromString(jsii.String("message-007")),
	},
	Table: myTable,
	ExpressionAttributeValues: map[string]*dynamoAttributeValue{
		":val": tasks.*dynamoAttributeValue_numberFromString(sfn.JsonPath_stringAt(jsii.String("$.Item.TotalCount.N"))),
		":rand": tasks.*dynamoAttributeValue_fromNumber(jsii.Number(20)),
	},
	UpdateExpression: jsii.String("SET TotalCount = :val + :rand"),
})

ECS

Step Functions supports ECS/Fargate through the service integration pattern.

RunTask

RunTask starts a new task using the specified task definition.

EC2

The EC2 launch type allows you to run your containerized applications on a cluster of Amazon EC2 instances that you manage.

When a task that uses the EC2 launch type is launched, Amazon ECS must determine where to place the task based on the requirements specified in the task definition, such as CPU and memory. Similarly, when you scale down the task count, Amazon ECS must determine which tasks to terminate. You can apply task placement strategies and constraints to customize how Amazon ECS places and terminates tasks. Learn more about task placement

The latest ACTIVE revision of the passed task definition is used for running the task.

The following example runs a job from a task definition on EC2

vpc := ec2.Vpc_FromLookup(this, jsii.String("Vpc"), &VpcLookupOptions{
	IsDefault: jsii.Boolean(true),
})

cluster := ecs.NewCluster(this, jsii.String("Ec2Cluster"), &ClusterProps{
	Vpc: Vpc,
})
cluster.AddCapacity(jsii.String("DefaultAutoScalingGroup"), &AddCapacityOptions{
	InstanceType: ec2.NewInstanceType(jsii.String("t2.micro")),
	VpcSubnets: &SubnetSelection{
		SubnetType: ec2.SubnetType_PUBLIC,
	},
})

taskDefinition := ecs.NewTaskDefinition(this, jsii.String("TD"), &TaskDefinitionProps{
	Compatibility: ecs.Compatibility_EC2,
})

taskDefinition.AddContainer(jsii.String("TheContainer"), &ContainerDefinitionOptions{
	Image: ecs.ContainerImage_FromRegistry(jsii.String("foo/bar")),
	MemoryLimitMiB: jsii.Number(256),
})

runTask := tasks.NewEcsRunTask(this, jsii.String("Run"), &EcsRunTaskProps{
	IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
	Cluster: Cluster,
	TaskDefinition: TaskDefinition,
	LaunchTarget: tasks.NewEcsEc2LaunchTarget(&EcsEc2LaunchTargetOptions{
		PlacementStrategies: []placementStrategy{
			ecs.*placementStrategy_SpreadAcrossInstances(),
			ecs.*placementStrategy_PackedByCpu(),
			ecs.*placementStrategy_Randomly(),
		},
		PlacementConstraints: []placementConstraint{
			ecs.*placementConstraint_MemberOf(jsii.String("blieptuut")),
		},
	}),
	PropagatedTagSource: ecs.PropagatedTagSource_TASK_DEFINITION,
})

Fargate

AWS Fargate is a serverless compute engine for containers that works with Amazon Elastic Container Service (ECS). Fargate makes it easy for you to focus on building your applications. Fargate removes the need to provision and manage servers, lets you specify and pay for resources per application, and improves security through application isolation by design. Learn more about Fargate

The Fargate launch type allows you to run your containerized applications without the need to provision and manage the backend infrastructure. Just register your task definition and Fargate launches the container for you. The latest ACTIVE revision of the passed task definition is used for running the task. Learn more about Fargate Versioning

The following example runs a job from a task definition on Fargate

vpc := ec2.Vpc_FromLookup(this, jsii.String("Vpc"), &VpcLookupOptions{
	IsDefault: jsii.Boolean(true),
})

cluster := ecs.NewCluster(this, jsii.String("FargateCluster"), &ClusterProps{
	Vpc: Vpc,
})

taskDefinition := ecs.NewTaskDefinition(this, jsii.String("TD"), &TaskDefinitionProps{
	MemoryMiB: jsii.String("512"),
	Cpu: jsii.String("256"),
	Compatibility: ecs.Compatibility_FARGATE,
})

containerDefinition := taskDefinition.AddContainer(jsii.String("TheContainer"), &ContainerDefinitionOptions{
	Image: ecs.ContainerImage_FromRegistry(jsii.String("foo/bar")),
	MemoryLimitMiB: jsii.Number(256),
})

runTask := tasks.NewEcsRunTask(this, jsii.String("RunFargate"), &EcsRunTaskProps{
	IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
	Cluster: Cluster,
	TaskDefinition: TaskDefinition,
	AssignPublicIp: jsii.Boolean(true),
	ContainerOverrides: []containerOverride{
		&containerOverride{
			ContainerDefinition: *ContainerDefinition,
			Environment: []taskEnvironmentVariable{
				&taskEnvironmentVariable{
					Name: jsii.String("SOME_KEY"),
					Value: sfn.JsonPath_StringAt(jsii.String("$.SomeKey")),
				},
			},
		},
	},
	LaunchTarget: tasks.NewEcsFargateLaunchTarget(),
	PropagatedTagSource: ecs.PropagatedTagSource_TASK_DEFINITION,
})

Override CPU and Memory Parameter

By setting the property cpu or memoryMiB, you can override the Fargate or EC2 task instance size at runtime.

see: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html

vpc := ec2.Vpc_FromLookup(this, jsii.String("Vpc"), &VpcLookupOptions{
	IsDefault: jsii.Boolean(true),
})
cluster := ecs.NewCluster(this, jsii.String("ECSCluster"), &ClusterProps{
	Vpc: Vpc,
})

taskDefinition := ecs.NewTaskDefinition(this, jsii.String("TD"), &TaskDefinitionProps{
	Compatibility: ecs.Compatibility_FARGATE,
	Cpu: jsii.String("256"),
	MemoryMiB: jsii.String("512"),
})

taskDefinition.AddContainer(jsii.String("TheContainer"), &ContainerDefinitionOptions{
	Image: ecs.ContainerImage_FromRegistry(jsii.String("foo/bar")),
})

runTask := tasks.NewEcsRunTask(this, jsii.String("Run"), &EcsRunTaskProps{
	IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
	Cluster: Cluster,
	TaskDefinition: TaskDefinition,
	LaunchTarget: tasks.NewEcsFargateLaunchTarget(),
	Cpu: jsii.String("1024"),
	MemoryMiB: jsii.String("1048"),
})

ECS enable Exec

By setting the property enableExecuteCommand to true, you can enable the ECS Exec feature for the task for either Fargate or EC2 launch types.

vpc := ec2.Vpc_FromLookup(this, jsii.String("Vpc"), &VpcLookupOptions{
	IsDefault: jsii.Boolean(true),
})
cluster := ecs.NewCluster(this, jsii.String("ECSCluster"), &ClusterProps{
	Vpc: Vpc,
})

taskDefinition := ecs.NewTaskDefinition(this, jsii.String("TD"), &TaskDefinitionProps{
	Compatibility: ecs.Compatibility_EC2,
})

taskDefinition.AddContainer(jsii.String("TheContainer"), &ContainerDefinitionOptions{
	Image: ecs.ContainerImage_FromRegistry(jsii.String("foo/bar")),
	MemoryLimitMiB: jsii.Number(256),
})

runTask := tasks.NewEcsRunTask(this, jsii.String("Run"), &EcsRunTaskProps{
	IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
	Cluster: Cluster,
	TaskDefinition: TaskDefinition,
	LaunchTarget: tasks.NewEcsEc2LaunchTarget(),
	EnableExecuteCommand: jsii.Boolean(true),
})

EMR

Step Functions supports Amazon EMR through the service integration pattern. The service integration APIs correspond to Amazon EMR APIs but differ in the parameters that are used.

Read more about the differences when using these service integrations.

Create Cluster

Creates and starts running a cluster (job flow). Corresponds to the runJobFlow API in EMR.

clusterRole := iam.NewRole(this, jsii.String("ClusterRole"), &RoleProps{
	AssumedBy: iam.NewServicePrincipal(jsii.String("ec2.amazonaws.com")),
})

serviceRole := iam.NewRole(this, jsii.String("ServiceRole"), &RoleProps{
	AssumedBy: iam.NewServicePrincipal(jsii.String("elasticmapreduce.amazonaws.com")),
})

autoScalingRole := iam.NewRole(this, jsii.String("AutoScalingRole"), &RoleProps{
	AssumedBy: iam.NewServicePrincipal(jsii.String("elasticmapreduce.amazonaws.com")),
})

autoScalingRole.AssumeRolePolicy.AddStatements(
iam.NewPolicyStatement(&PolicyStatementProps{
	Effect: iam.Effect_ALLOW,
	Principals: []iPrincipal{
		iam.NewServicePrincipal(jsii.String("application-autoscaling.amazonaws.com")),
	},
	Actions: []*string{
		jsii.String("sts:AssumeRole"),
	},
}))

tasks.NewEmrCreateCluster(this, jsii.String("Create Cluster"), &EmrCreateClusterProps{
	Instances: &InstancesConfigProperty{
	},
	ClusterRole: ClusterRole,
	Name: sfn.TaskInput_FromJsonPathAt(jsii.String("$.ClusterName")).value,
	ServiceRole: ServiceRole,
	AutoScalingRole: AutoScalingRole,
})

You can use the launch specification for On-Demand and Spot instances in the fleet.

tasks.NewEmrCreateCluster(this, jsii.String("OnDemandSpecification"), &EmrCreateClusterProps{
	Instances: &InstancesConfigProperty{
		InstanceFleets: []instanceFleetConfigProperty{
			&instanceFleetConfigProperty{
				InstanceFleetType: tasks.EmrCreateCluster.InstanceRoleType_MASTER,
				LaunchSpecifications: &InstanceFleetProvisioningSpecificationsProperty{
					OnDemandSpecification: &OnDemandProvisioningSpecificationProperty{
						AllocationStrategy: tasks.EmrCreateCluster.OnDemandAllocationStrategy_LOWEST_PRICE,
					},
				},
			},
		},
	},
	Name: jsii.String("OnDemandCluster"),
	IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
})

tasks.NewEmrCreateCluster(this, jsii.String("SpotSpecification"), &EmrCreateClusterProps{
	Instances: &InstancesConfigProperty{
		InstanceFleets: []*instanceFleetConfigProperty{
			&instanceFleetConfigProperty{
				InstanceFleetType: tasks.EmrCreateCluster.InstanceRoleType_MASTER,
				LaunchSpecifications: &InstanceFleetProvisioningSpecificationsProperty{
					SpotSpecification: &SpotProvisioningSpecificationProperty{
						AllocationStrategy: tasks.EmrCreateCluster.SpotAllocationStrategy_CAPACITY_OPTIMIZED,
						TimeoutAction: tasks.EmrCreateCluster.SpotTimeoutAction_TERMINATE_CLUSTER,
						Timeout: awscdk.Duration_Minutes(jsii.Number(5)),
					},
				},
			},
		},
	},
	Name: jsii.String("SpotCluster"),
	IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
})

If you want to run multiple steps in parallel, you can specify the stepConcurrencyLevel property. The concurrency range is between 1 and 256 inclusive, where the default concurrency of 1 means no step concurrency is allowed. stepConcurrencyLevel requires the EMR release label to be 5.28.0 or above.

tasks.NewEmrCreateCluster(this, jsii.String("Create Cluster"), &EmrCreateClusterProps{
	Instances: &InstancesConfigProperty{
	},
	Name: sfn.TaskInput_FromJsonPathAt(jsii.String("$.ClusterName")).value,
	StepConcurrencyLevel: jsii.Number(10),
})

If you want to use an auto-termination policy, you can specify the autoTerminationPolicyIdleTimeout property. Specifies the amount of idle time after which the cluster automatically terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).

tasks.NewEmrCreateCluster(this, jsii.String("Create Cluster"), &EmrCreateClusterProps{
	Instances: &InstancesConfigProperty{
	},
	Name: jsii.String("ClusterName"),
	AutoTerminationPolicyIdleTimeout: awscdk.Duration_Seconds(jsii.Number(100)),
})

Termination Protection

Locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or a job-flow error.

Corresponds to the setTerminationProtection API in EMR.

tasks.NewEmrSetClusterTerminationProtection(this, jsii.String("Task"), &EmrSetClusterTerminationProtectionProps{
	ClusterId: jsii.String("ClusterId"),
	TerminationProtected: jsii.Boolean(false),
})

Terminate Cluster

Shuts down a cluster (job flow). Corresponds to the terminateJobFlows API in EMR.

tasks.NewEmrTerminateCluster(this, jsii.String("Task"), &EmrTerminateClusterProps{
	ClusterId: jsii.String("ClusterId"),
})

Add Step

Adds a new step to a running cluster. Corresponds to the addJobFlowSteps API in EMR.

tasks.NewEmrAddStep(this, jsii.String("Task"), &EmrAddStepProps{
	ClusterId: jsii.String("ClusterId"),
	Name: jsii.String("StepName"),
	Jar: jsii.String("Jar"),
	ActionOnFailure: tasks.ActionOnFailure_CONTINUE,
})

To specify a custom runtime role use the executionRoleArn property.

Note: The EMR cluster must be created with a security configuration and the runtime role must have a specific trust policy. See this blog post for more details.

import emr "github.com/aws/aws-cdk-go/awscdk"


cfnSecurityConfiguration := emr.NewCfnSecurityConfiguration(this, jsii.String("EmrSecurityConfiguration"), &CfnSecurityConfigurationProps{
	Name: jsii.String("AddStepRuntimeRoleSecConfig"),
	SecurityConfiguration: jSON.parse(jsii.String(`
	    {
	      "AuthorizationConfiguration": {
	          "IAMConfiguration": {
	              "EnableApplicationScopedIAMRole": true,
	              "ApplicationScopedIAMRoleConfiguration":
	                  {
	                      "PropagateSourceIdentity": true
	                  }
	          },
	          "LakeFormationConfiguration": {
	              "AuthorizedSessionTagValue": "Amazon EMR"
	          }
	      }
	    }`)),
})

task := tasks.NewEmrCreateCluster(this, jsii.String("Create Cluster"), &EmrCreateClusterProps{
	Instances: &InstancesConfigProperty{
	},
	Name: sfn.TaskInput_FromJsonPathAt(jsii.String("$.ClusterName")).value,
	SecurityConfiguration: cfnSecurityConfiguration.Name,
})

executionRole := iam.NewRole(this, jsii.String("Role"), &RoleProps{
	AssumedBy: iam.NewArnPrincipal(task.clusterRole.RoleArn),
})

executionRole.AssumeRolePolicy.AddStatements(
iam.NewPolicyStatement(&PolicyStatementProps{
	Effect: iam.Effect_ALLOW,
	Principals: []iPrincipal{
		task.clusterRole,
	},
	Actions: []*string{
		jsii.String("sts:SetSourceIdentity"),
	},
}),
iam.NewPolicyStatement(&PolicyStatementProps{
	Effect: iam.Effect_ALLOW,
	Principals: []*iPrincipal{
		task.clusterRole,
	},
	Actions: []*string{
		jsii.String("sts:TagSession"),
	},
	Conditions: map[string]interface{}{
		"StringEquals": map[string]*string{
			"aws:RequestTag/LakeFormationAuthorizedCaller": jsii.String("Amazon EMR"),
		},
	},
}))

tasks.NewEmrAddStep(this, jsii.String("Task"), &EmrAddStepProps{
	ClusterId: jsii.String("ClusterId"),
	ExecutionRoleArn: executionRole.RoleArn,
	Name: jsii.String("StepName"),
	Jar: jsii.String("Jar"),
	ActionOnFailure: tasks.ActionOnFailure_CONTINUE,
})

Cancel Step

Cancels a pending step in a running cluster. Corresponds to the cancelSteps API in EMR.

tasks.NewEmrCancelStep(this, jsii.String("Task"), &EmrCancelStepProps{
	ClusterId: jsii.String("ClusterId"),
	StepId: jsii.String("StepId"),
})

Modify Instance Fleet

Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetName.

Corresponds to the modifyInstanceFleet API in EMR.

tasks.NewEmrModifyInstanceFleetByName(this, jsii.String("Task"), &EmrModifyInstanceFleetByNameProps{
	ClusterId: jsii.String("ClusterId"),
	InstanceFleetName: jsii.String("InstanceFleetName"),
	TargetOnDemandCapacity: jsii.Number(2),
	TargetSpotCapacity: jsii.Number(0),
})

Modify Instance Group

Modifies the number of nodes and configuration settings of an instance group.

Corresponds to the modifyInstanceGroups API in EMR.

tasks.NewEmrModifyInstanceGroupByName(this, jsii.String("Task"), &EmrModifyInstanceGroupByNameProps{
	ClusterId: jsii.String("ClusterId"),
	InstanceGroupName: sfn.JsonPath_StringAt(jsii.String("$.InstanceGroupName")),
	InstanceGroup: &InstanceGroupModifyConfigProperty{
		InstanceCount: jsii.Number(1),
	},
})

EMR on EKS

Step Functions supports Amazon EMR on EKS through the service integration pattern. The service integration APIs correspond to Amazon EMR on EKS APIs, but differ in the parameters that are used.

Read more about the differences when using these service integrations.

Setting up the EKS cluster is required.

Create Virtual Cluster

The CreateVirtualCluster API creates a single virtual cluster that's mapped to a single Kubernetes namespace.

The EKS cluster containing the Kubernetes namespace where the virtual cluster will be mapped can be passed in from the task input.

tasks.NewEmrContainersCreateVirtualCluster(this, jsii.String("Create a Virtual Cluster"), &EmrContainersCreateVirtualClusterProps{
	EksCluster: tasks.EksClusterInput_FromTaskInput(sfn.TaskInput_FromText(jsii.String("clusterId"))),
})

The EKS cluster can also be passed in directly.

import eks "github.com/aws/aws-cdk-go/awscdk"

var eksCluster cluster


tasks.NewEmrContainersCreateVirtualCluster(this, jsii.String("Create a Virtual Cluster"), &EmrContainersCreateVirtualClusterProps{
	EksCluster: tasks.EksClusterInput_FromCluster(eksCluster),
})

By default, the Kubernetes namespace that a virtual cluster maps to is "default", but a specific namespace within an EKS cluster can be selected.

tasks.NewEmrContainersCreateVirtualCluster(this, jsii.String("Create a Virtual Cluster"), &EmrContainersCreateVirtualClusterProps{
	EksCluster: tasks.EksClusterInput_FromTaskInput(sfn.TaskInput_FromText(jsii.String("clusterId"))),
	EksNamespace: jsii.String("specified-namespace"),
})

Delete Virtual Cluster

The DeleteVirtualCluster API deletes a virtual cluster.

tasks.NewEmrContainersDeleteVirtualCluster(this, jsii.String("Delete a Virtual Cluster"), &EmrContainersDeleteVirtualClusterProps{
	VirtualClusterId: sfn.TaskInput_FromJsonPathAt(jsii.String("$.virtualCluster")),
})

Start Job Run

The StartJobRun API starts a job run. A job is a unit of work that you submit to Amazon EMR on EKS for execution. The work performed by the job can be defined by a Spark jar, PySpark script, or SparkSQL query. A job run is an execution of the job on the virtual cluster.

Required setup:

If not done already, follow the steps to setup EMR on EKS and create an EKS Cluster.
Enable Cluster access
Enable IAM Role access

The following actions must be performed if the virtual cluster ID is supplied from the task input. Otherwise, if it is supplied statically in the state machine definition, these actions will be done automatically.

Create an IAM role
Update the Role Trust Policy of the Job Execution Role.

The job can be configured with spark submit parameters:

tasks.NewEmrContainersStartJobRun(this, jsii.String("EMR Containers Start Job Run"), &EmrContainersStartJobRunProps{
	VirtualCluster: tasks.VirtualClusterInput_FromVirtualClusterId(jsii.String("de92jdei2910fwedz")),
	ReleaseLabel: tasks.ReleaseLabel_EMR_6_2_0(),
	JobDriver: &JobDriver{
		SparkSubmitJobDriver: &SparkSubmitJobDriver{
			EntryPoint: sfn.TaskInput_FromText(jsii.String("local:///usr/lib/spark/examples/src/main/python/pi.py")),
			SparkSubmitParameters: jsii.String("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1"),
		},
	},
})

Configuring the job can also be done via application configuration:

tasks.NewEmrContainersStartJobRun(this, jsii.String("EMR Containers Start Job Run"), &EmrContainersStartJobRunProps{
	VirtualCluster: tasks.VirtualClusterInput_FromVirtualClusterId(jsii.String("de92jdei2910fwedz")),
	ReleaseLabel: tasks.ReleaseLabel_EMR_6_2_0(),
	JobName: jsii.String("EMR-Containers-Job"),
	JobDriver: &JobDriver{
		SparkSubmitJobDriver: &SparkSubmitJobDriver{
			EntryPoint: sfn.TaskInput_FromText(jsii.String("local:///usr/lib/spark/examples/src/main/python/pi.py")),
		},
	},
	ApplicationConfig: []applicationConfiguration{
		&applicationConfiguration{
			Classification: tasks.Classification_SPARK_DEFAULTS(),
			Properties: map[string]*string{
				"spark.executor.instances": jsii.String("1"),
				"spark.executor.memory": jsii.String("512M"),
			},
		},
	},
})

Job monitoring can be enabled if monitoring.logging is set true. This automatically generates an S3 bucket and CloudWatch logs.

tasks.NewEmrContainersStartJobRun(this, jsii.String("EMR Containers Start Job Run"), &EmrContainersStartJobRunProps{
	VirtualCluster: tasks.VirtualClusterInput_FromVirtualClusterId(jsii.String("de92jdei2910fwedz")),
	ReleaseLabel: tasks.ReleaseLabel_EMR_6_2_0(),
	JobDriver: &JobDriver{
		SparkSubmitJobDriver: &SparkSubmitJobDriver{
			EntryPoint: sfn.TaskInput_FromText(jsii.String("local:///usr/lib/spark/examples/src/main/python/pi.py")),
			SparkSubmitParameters: jsii.String("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1"),
		},
	},
	Monitoring: &Monitoring{
		Logging: jsii.Boolean(true),
	},
})

Otherwise, providing monitoring for jobs with existing log groups and log buckets is also available.

import logs "github.com/aws/aws-cdk-go/awscdk"


logGroup := logs.NewLogGroup(this, jsii.String("Log Group"))
logBucket := s3.NewBucket(this, jsii.String("S3 Bucket"))

tasks.NewEmrContainersStartJobRun(this, jsii.String("EMR Containers Start Job Run"), &EmrContainersStartJobRunProps{
	VirtualCluster: tasks.VirtualClusterInput_FromVirtualClusterId(jsii.String("de92jdei2910fwedz")),
	ReleaseLabel: tasks.ReleaseLabel_EMR_6_2_0(),
	JobDriver: &JobDriver{
		SparkSubmitJobDriver: &SparkSubmitJobDriver{
			EntryPoint: sfn.TaskInput_FromText(jsii.String("local:///usr/lib/spark/examples/src/main/python/pi.py")),
			SparkSubmitParameters: jsii.String("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1"),
		},
	},
	Monitoring: &Monitoring{
		LogGroup: logGroup,
		LogBucket: logBucket,
	},
})

Users can provide their own existing Job Execution Role.

tasks.NewEmrContainersStartJobRun(this, jsii.String("EMR Containers Start Job Run"), &EmrContainersStartJobRunProps{
	VirtualCluster: tasks.VirtualClusterInput_FromTaskInput(sfn.TaskInput_FromJsonPathAt(jsii.String("$.VirtualClusterId"))),
	ReleaseLabel: tasks.ReleaseLabel_EMR_6_2_0(),
	JobName: jsii.String("EMR-Containers-Job"),
	ExecutionRole: iam.Role_FromRoleArn(this, jsii.String("Job-Execution-Role"), jsii.String("arn:aws:iam::xxxxxxxxxxxx:role/JobExecutionRole")),
	JobDriver: &JobDriver{
		SparkSubmitJobDriver: &SparkSubmitJobDriver{
			EntryPoint: sfn.TaskInput_FromText(jsii.String("local:///usr/lib/spark/examples/src/main/python/pi.py")),
			SparkSubmitParameters: jsii.String("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1"),
		},
	},
})

EKS

Step Functions supports Amazon EKS through the service integration pattern. The service integration APIs correspond to Amazon EKS APIs.

Read more about the differences when using these service integrations.

Call

Read and write Kubernetes resource objects via a Kubernetes API endpoint. Corresponds to the call API in Step Functions Connector.

The following code snippet includes a Task state that uses eks:call to list the pods.

import "github.com/aws/aws-cdk-go/awscdk"


myEksCluster := eks.NewCluster(this, jsii.String("my sample cluster"), &ClusterProps{
	Version: eks.KubernetesVersion_V1_18(),
	ClusterName: jsii.String("myEksCluster"),
})

tasks.NewEksCall(this, jsii.String("Call a EKS Endpoint"), &EksCallProps{
	Cluster: myEksCluster,
	HttpMethod: tasks.HttpMethods_GET,
	HttpPath: jsii.String("/api/v1/namespaces/default/pods"),
})

EventBridge

Step Functions supports Amazon EventBridge through the service integration pattern. The service integration APIs correspond to Amazon EventBridge APIs.

Read more about the differences when using these service integrations.

Put Events

Send events to an EventBridge bus. Corresponds to the put-events API in Step Functions Connector.

The following code snippet includes a Task state that uses events:putevents to send an event to the default bus.

import events "github.com/aws/aws-cdk-go/awscdk"


myEventBus := events.NewEventBus(this, jsii.String("EventBus"), &EventBusProps{
	EventBusName: jsii.String("MyEventBus1"),
})

tasks.NewEventBridgePutEvents(this, jsii.String("Send an event to EventBridge"), &EventBridgePutEventsProps{
	Entries: []eventBridgePutEventsEntry{
		&eventBridgePutEventsEntry{
			Detail: sfn.TaskInput_FromObject(map[string]interface{}{
				"Message": jsii.String("Hello from Step Functions!"),
			}),
			EventBus: myEventBus,
			DetailType: jsii.String("MessageFromStepFunctions"),
			Source: jsii.String("step.functions"),
		},
	},
})

Glue

Step Functions supports AWS Glue through the service integration pattern.

StartJobRun

You can call the StartJobRun API from a Task state.

tasks.NewGlueStartJobRun(this, jsii.String("Task"), &GlueStartJobRunProps{
	GlueJobName: jsii.String("my-glue-job"),
	Arguments: sfn.TaskInput_FromObject(map[string]interface{}{
		"key": jsii.String("value"),
	}),
	TaskTimeout: sfn.Timeout_Duration(awscdk.Duration_Minutes(jsii.Number(30))),
	NotifyDelayAfter: awscdk.Duration_*Minutes(jsii.Number(5)),
})

You can configure workers by setting the workerType and numberOfWorkers properties.

tasks.NewGlueStartJobRun(this, jsii.String("Task"), &GlueStartJobRunProps{
	GlueJobName: jsii.String("my-glue-job"),
	WorkerConfiguration: &WorkerConfigurationProperty{
		WorkerType: tasks.WorkerType_G_1X,
		 // Worker type
		NumberOfWorkers: jsii.Number(2),
	},
})

You can choose the execution class by setting the executionClass property.

tasks.NewGlueStartJobRun(this, jsii.String("Task"), &GlueStartJobRunProps{
	GlueJobName: jsii.String("my-glue-job"),
	ExecutionClass: tasks.ExecutionClass_FLEX,
})

StartCrawlerRun

You can call the StartCrawler API from a Task state through AWS SDK service integrations.

import glue "github.com/aws/aws-cdk-go/awscdk"

var myCrawler cfnCrawler


// You can get the crawler name from `crawler.ref`
// You can get the crawler name from `crawler.ref`
tasks.NewGlueStartCrawlerRun(this, jsii.String("Task1"), &GlueStartCrawlerRunProps{
	CrawlerName: myCrawler.ref,
})

// Of course, you can also specify the crawler name directly.
// Of course, you can also specify the crawler name directly.
tasks.NewGlueStartCrawlerRun(this, jsii.String("Task2"), &GlueStartCrawlerRunProps{
	CrawlerName: jsii.String("my-crawler-job"),
})

Glue DataBrew

Step Functions supports AWS Glue DataBrew through the service integration pattern.

Start Job Run

You can call the StartJobRun API from a Task state.

tasks.NewGlueDataBrewStartJobRun(this, jsii.String("Task"), &GlueDataBrewStartJobRunProps{
	Name: jsii.String("databrew-job"),
})

Invoke HTTP API

Step Functions supports calling third-party APIs with credentials managed by Amazon EventBridge Connections.

The following snippet creates a new API destination connection, and uses it to make a POST request to the specified URL. The endpoint response is available at the $.ResponseBody path.

import "github.com/aws/aws-cdk-go/awscdk"


connection := events.NewConnection(this, jsii.String("Connection"), &ConnectionProps{
	Authorization: events.Authorization_Basic(jsii.String("username"), awscdk.SecretValue_UnsafePlainText(jsii.String("password"))),
})

tasks.NewHttpInvoke(this, jsii.String("Invoke HTTP API"), &HttpInvokeProps{
	ApiRoot: jsii.String("https://api.example.com"),
	ApiEndpoint: sfn.TaskInput_FromText(jsii.String("path/to/resource")),
	Body: sfn.TaskInput_FromObject(map[string]interface{}{
		"foo": jsii.String("bar"),
	}),
	Connection: Connection,
	Headers: sfn.TaskInput_*FromObject(map[string]interface{}{
		"Content-Type": jsii.String("application/json"),
	}),
	Method: sfn.TaskInput_*FromText(jsii.String("POST")),
	QueryStringParameters: sfn.TaskInput_*FromObject(map[string]interface{}{
		"id": jsii.String("123"),
	}),
	UrlEncodingFormat: tasks.URLEncodingFormat_BRACKETS,
})

Lambda

Step Functions supports AWS Lambda through the service integration pattern.

Invoke

Invoke a Lambda function.

You can specify the input to your Lambda function through the payload attribute. By default, Step Functions invokes Lambda function with the state input (JSON path '$') as the input.

The following snippet invokes a Lambda Function with the state input as the payload by referencing the $ path.

var fn function

tasks.NewLambdaInvoke(this, jsii.String("Invoke with state input"), &LambdaInvokeProps{
	LambdaFunction: fn,
})

When a function is invoked, the Lambda service sends these response elements back.

⚠️ The response from the Lambda function is in an attribute called Payload

The following snippet invokes a Lambda Function by referencing the $.Payload path to reference the output of a Lambda executed before it.

var fn function

tasks.NewLambdaInvoke(this, jsii.String("Invoke with empty object as payload"), &LambdaInvokeProps{
	LambdaFunction: fn,
	Payload: sfn.TaskInput_FromObject(map[string]interface{}{
	}),
})

// use the output of fn as input
// use the output of fn as input
tasks.NewLambdaInvoke(this, jsii.String("Invoke with payload field in the state input"), &LambdaInvokeProps{
	LambdaFunction: fn,
	Payload: sfn.TaskInput_FromJsonPathAt(jsii.String("$.Payload")),
})

The following snippet invokes a Lambda and sets the task output to only include the Lambda function response.

var fn function

tasks.NewLambdaInvoke(this, jsii.String("Invoke and set function response as task output"), &LambdaInvokeProps{
	LambdaFunction: fn,
	OutputPath: jsii.String("$.Payload"),
})

If you want to combine the input and the Lambda function response you can use the payloadResponseOnly property and specify the resultPath. This will put the Lambda function ARN directly in the "Resource" string, but it conflicts with the integrationPattern, invocationType, clientContext, and qualifier properties.

var fn function

tasks.NewLambdaInvoke(this, jsii.String("Invoke and combine function response with task input"), &LambdaInvokeProps{
	LambdaFunction: fn,
	PayloadResponseOnly: jsii.Boolean(true),
	ResultPath: jsii.String("$.fn"),
})

You can have Step Functions pause a task, and wait for an external process to return a task token. Read more about the callback pattern

To use the callback pattern, set the token property on the task. Call the Step Functions SendTaskSuccess or SendTaskFailure APIs with the token to indicate that the task has completed and the state machine should resume execution.

The following snippet invokes a Lambda with the task token as part of the input to the Lambda.

var fn function

tasks.NewLambdaInvoke(this, jsii.String("Invoke with callback"), &LambdaInvokeProps{
	LambdaFunction: fn,
	IntegrationPattern: sfn.IntegrationPattern_WAIT_FOR_TASK_TOKEN,
	Payload: sfn.TaskInput_FromObject(map[string]interface{}{
		"token": sfn.JsonPath_taskToken(),
		"input": sfn.JsonPath_stringAt(jsii.String("$.someField")),
	}),
})

⚠️ The task will pause until it receives that task token back with a SendTaskSuccess or SendTaskFailure call. Learn more about Callback with the Task Token.

AWS Lambda can occasionally experience transient service errors. In this case, invoking Lambda results in a 500 error, such as ClientExecutionTimeoutException, ServiceException, AWSLambdaException, or SdkClientException. As a best practice, the LambdaInvoke task will retry on those errors with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts. Set the retryOnServiceExceptions prop to false to disable this behavior.

MediaConvert

Step Functions supports AWS MediaConvert through the Optimized integration pattern.

CreateJob

The CreateJob API creates a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

You can call the CreateJob API from a Task state. Optionally you can specify the integrationPattern.

Make sure you update the required fields - Role & Settings and refer CreateJobRequest for all other optional parameters.

tasks.NewMediaConvertCreateJob(this, jsii.String("CreateJob"), &MediaConvertCreateJobProps{
	CreateJobRequest: map[string]interface{}{
		"Role": jsii.String("arn:aws:iam::123456789012:role/MediaConvertRole"),
		"Settings": map[string][]map[string]interface{}{
			"OutputGroups": []map[string]interface{}{
				map[string]interface{}{
					"Outputs": []map[string]interface{}{
						map[string]interface{}{
							"ContainerSettings": map[string]*string{
								"Container": jsii.String("MP4"),
							},
							"VideoDescription": map[string]map[string]interface{}{
								"CodecSettings": map[string]interface{}{
									"Codec": jsii.String("H_264"),
									"H264Settings": map[string]interface{}{
										"MaxBitrate": jsii.Number(1000),
										"RateControlMode": jsii.String("QVBR"),
										"SceneChangeDetect": jsii.String("TRANSITION_DETECTION"),
									},
								},
							},
							"AudioDescriptions": []map[string]map[string]interface{}{
								map[string]map[string]interface{}{
									"CodecSettings": map[string]interface{}{
										"Codec": jsii.String("AAC"),
										"AacSettings": map[string]interface{}{
											"Bitrate": jsii.Number(96000),
											"CodingMode": jsii.String("CODING_MODE_2_0"),
											"SampleRate": jsii.Number(48000),
										},
									},
								},
							},
						},
					},
					"OutputGroupSettings": map[string]interface{}{
						"Type": jsii.String("FILE_GROUP_SETTINGS"),
						"FileGroupSettings": map[string]*string{
							"Destination": jsii.String("s3://EXAMPLE-DESTINATION-BUCKET/"),
						},
					},
				},
			},
			"Inputs": []map[string]interface{}{
				map[string]interface{}{
					"AudioSelectors": map[string]map[string]*string{
						"Audio Selector 1": map[string]*string{
							"DefaultSelection": jsii.String("DEFAULT"),
						},
					},
					"FileInput": jsii.String("s3://EXAMPLE-SOURCE-BUCKET/EXAMPLE-SOURCE_FILE"),
				},
			},
		},
	},
	IntegrationPattern: sfn.IntegrationPattern_RUN_JOB,
})

SageMaker

Step Functions supports AWS SageMaker through the service integration pattern.

If your training job or model uses resources from AWS Marketplace, network isolation is required. To do so, set the enableNetworkIsolation property to true for SageMakerCreateModel or SageMakerCreateTrainingJob.

To set environment variables for the Docker container use the environment property.

Create Training Job

You can call the CreateTrainingJob API from a Task state.

tasks.NewSageMakerCreateTrainingJob(this, jsii.String("TrainSagemaker"), &SageMakerCreateTrainingJobProps{
	TrainingJobName: sfn.JsonPath_StringAt(jsii.String("$.JobName")),
	AlgorithmSpecification: &AlgorithmSpecification{
		AlgorithmName: jsii.String("BlazingText"),
		TrainingInputMode: tasks.InputMode_FILE,
	},
	InputDataConfig: []channel{
		&channel{
			ChannelName: jsii.String("train"),
			DataSource: &DataSource{
				S3DataSource: &S3DataSource{
					S3DataType: tasks.S3DataType_S3_PREFIX,
					S3Location: tasks.S3Location_FromJsonExpression(jsii.String("$.S3Bucket")),
				},
			},
		},
	},
	OutputDataConfig: &OutputDataConfig{
		S3OutputLocation: tasks.S3Location_FromBucket(s3.Bucket_FromBucketName(this, jsii.String("Bucket"), jsii.String("amzn-s3-demo-bucket")), jsii.String("myoutputpath")),
	},
	ResourceConfig: &ResourceConfig{
		InstanceCount: jsii.Number(1),
		InstanceType: ec2.NewInstanceType(sfn.JsonPath_*StringAt(jsii.String("$.InstanceType"))),
		VolumeSize: awscdk.Size_Gibibytes(jsii.Number(50)),
	},
	 // optional: default is 1 instance of EC2 `M4.XLarge` with `10GB` volume
	StoppingCondition: &StoppingCondition{
		MaxRuntime: awscdk.Duration_Hours(jsii.Number(2)),
	},
})

You can specify TrainingInputMode via the trainingInputMode property.

To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, choose InputMode.FILE if an algorithm supports it.
To stream data directly from Amazon S3 to the container, choose InputMode.PIPE if an algorithm supports it.
To stream data directly from Amazon S3 to the container with no code changes and to provide file system access to the data, choose InputMode.FAST_FILE if an algorithm supports it.

Create Transform Job

You can call the CreateTransformJob API from a Task state.

tasks.NewSageMakerCreateTransformJob(this, jsii.String("Batch Inference"), &SageMakerCreateTransformJobProps{
	TransformJobName: jsii.String("MyTransformJob"),
	ModelName: jsii.String("MyModelName"),
	ModelClientOptions: &ModelClientOptions{
		InvocationsMaxRetries: jsii.Number(3),
		 // default is 0
		InvocationsTimeout: awscdk.Duration_Minutes(jsii.Number(5)),
	},
	TransformInput: &TransformInput{
		TransformDataSource: &TransformDataSource{
			S3DataSource: &TransformS3DataSource{
				S3Uri: jsii.String("s3://inputbucket/train"),
				S3DataType: tasks.S3DataType_S3_PREFIX,
			},
		},
	},
	TransformOutput: &TransformOutput{
		S3OutputPath: jsii.String("s3://outputbucket/TransformJobOutputPath"),
	},
	TransformResources: &TransformResources{
		InstanceCount: jsii.Number(1),
		InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_M4, ec2.InstanceSize_XLARGE),
	},
})

Create Endpoint

You can call the CreateEndpoint API from a Task state.

tasks.NewSageMakerCreateEndpoint(this, jsii.String("SagemakerEndpoint"), &SageMakerCreateEndpointProps{
	EndpointName: sfn.JsonPath_StringAt(jsii.String("$.EndpointName")),
	EndpointConfigName: sfn.JsonPath_*StringAt(jsii.String("$.EndpointConfigName")),
})

Create Endpoint Config

You can call the CreateEndpointConfig API from a Task state.

tasks.NewSageMakerCreateEndpointConfig(this, jsii.String("SagemakerEndpointConfig"), &SageMakerCreateEndpointConfigProps{
	EndpointConfigName: jsii.String("MyEndpointConfig"),
	ProductionVariants: []productionVariant{
		&productionVariant{
			InitialInstanceCount: jsii.Number(2),
			InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_M5, ec2.InstanceSize_XLARGE),
			ModelName: jsii.String("MyModel"),
			VariantName: jsii.String("awesome-variant"),
		},
	},
})

Create Model

You can call the CreateModel API from a Task state.

tasks.NewSageMakerCreateModel(this, jsii.String("Sagemaker"), &SageMakerCreateModelProps{
	ModelName: jsii.String("MyModel"),
	PrimaryContainer: tasks.NewContainerDefinition(&ContainerDefinitionOptions{
		Image: tasks.DockerImage_FromJsonExpression(sfn.JsonPath_StringAt(jsii.String("$.Model.imageName"))),
		Mode: tasks.Mode_SINGLE_MODEL,
		ModelS3Location: tasks.S3Location_FromJsonExpression(jsii.String("$.TrainingJob.ModelArtifacts.S3ModelArtifacts")),
	}),
})

Update Endpoint

You can call the UpdateEndpoint API from a Task state.

tasks.NewSageMakerUpdateEndpoint(this, jsii.String("SagemakerEndpoint"), &SageMakerUpdateEndpointProps{
	EndpointName: sfn.JsonPath_StringAt(jsii.String("$.Endpoint.Name")),
	EndpointConfigName: sfn.JsonPath_*StringAt(jsii.String("$.Endpoint.EndpointConfig")),
})

SNS

Step Functions supports Amazon SNS through the service integration pattern.

Publish

You can call the Publish API from a Task state to publish to an SNS topic.

topic := sns.NewTopic(this, jsii.String("Topic"))

// Use a field from the execution data as message.
task1 := tasks.NewSnsPublish(this, jsii.String("Publish1"), &SnsPublishProps{
	Topic: Topic,
	IntegrationPattern: sfn.IntegrationPattern_REQUEST_RESPONSE,
	Message: sfn.TaskInput_FromDataAt(jsii.String("$.state.message")),
	MessageAttributes: map[string]messageAttribute{
		"place": &messageAttribute{
			"value": sfn.JsonPath_stringAt(jsii.String("$.place")),
		},
		"pic": &messageAttribute{
			// BINARY must be explicitly set
			"dataType": tasks.MessageAttributeDataType_BINARY,
			"value": sfn.JsonPath_stringAt(jsii.String("$.pic")),
		},
		"people": &messageAttribute{
			"value": jsii.Number(4),
		},
		"handles": &messageAttribute{
			"value": []interface{}{
				jsii.String("@kslater"),
				jsii.String("@jjf"),
				nil,
				jsii.String("@mfanning"),
			},
		},
	},
})

// Combine a field from the execution data with
// a literal object.
task2 := tasks.NewSnsPublish(this, jsii.String("Publish2"), &SnsPublishProps{
	Topic: Topic,
	Message: sfn.TaskInput_FromObject(map[string]interface{}{
		"field1": jsii.String("somedata"),
		"field2": sfn.JsonPath_stringAt(jsii.String("$.field2")),
	}),
})

Step Functions

Step Functions supports AWS Step Functions through the service integration pattern.

Start Execution

You can manage AWS Step Functions executions.

AWS Step Functions supports it's own StartExecution API as a service integration.

// Define a state machine with one Pass state
child := sfn.NewStateMachine(this, jsii.String("ChildStateMachine"), &StateMachineProps{
	Definition: sfn.Chain_Start(sfn.NewPass(this, jsii.String("PassState"))),
})

// Include the state machine in a Task state with callback pattern
task := tasks.NewStepFunctionsStartExecution(this, jsii.String("ChildTask"), &StepFunctionsStartExecutionProps{
	StateMachine: child,
	IntegrationPattern: sfn.IntegrationPattern_WAIT_FOR_TASK_TOKEN,
	Input: sfn.TaskInput_FromObject(map[string]interface{}{
		"token": sfn.JsonPath_taskToken(),
		"foo": jsii.String("bar"),
	}),
	Name: jsii.String("MyExecutionName"),
})

// Define a second state machine with the Task state above
// Define a second state machine with the Task state above
sfn.NewStateMachine(this, jsii.String("ParentStateMachine"), &StateMachineProps{
	Definition: task,
})

You can utilize Associate Workflow Executions via the associateWithParent property. This allows the Step Functions UI to link child executions from parent executions, making it easier to trace execution flow across state machines.

var child stateMachine

task := tasks.NewStepFunctionsStartExecution(this, jsii.String("ChildTask"), &StepFunctionsStartExecutionProps{
	StateMachine: child,
	AssociateWithParent: jsii.Boolean(true),
})

This will add the payload AWS_STEP_FUNCTIONS_STARTED_BY_EXECUTION_ID.$: $$.Execution.Id to the inputproperty for you, which will pass the execution ID from the context object to the execution input. It requires input to be an object or not be set at all.

Invoke Activity

You can invoke a Step Functions Activity which enables you to have a task in your state machine where the work is performed by a worker that can be hosted on Amazon EC2, Amazon ECS, AWS Lambda, basically anywhere. Activities are a way to associate code running somewhere (known as an activity worker) with a specific task in a state machine.

When Step Functions reaches an activity task state, the workflow waits for an activity worker to poll for a task. An activity worker polls Step Functions by using GetActivityTask, and sending the ARN for the related activity.

After the activity worker completes its work, it can provide a report of its success or failure by using SendTaskSuccess or SendTaskFailure. These two calls use the taskToken provided by GetActivityTask to associate the result with that task.

The following example creates an activity and creates a task that invokes the activity.

submitJobActivity := sfn.NewActivity(this, jsii.String("SubmitJob"))

tasks.NewStepFunctionsInvokeActivity(this, jsii.String("Submit Job"), &StepFunctionsInvokeActivityProps{
	Activity: submitJobActivity,
})

Use the Parameters field to create a collection of key-value pairs that are passed as input. The values of each can either be static values that you include in your state machine definition, or selected from either the input or the context object with a path.

submitJobActivity := sfn.NewActivity(this, jsii.String("SubmitJob"))

tasks.NewStepFunctionsInvokeActivity(this, jsii.String("Submit Job"), &StepFunctionsInvokeActivityProps{
	Activity: submitJobActivity,
	Parameters: map[string]interface{}{
		"comment": jsii.String("Selecting what I care about."),
		"MyDetails": map[string]interface{}{
			"size": sfn.JsonPath_stringAt(jsii.String("$.product.details.size")),
			"exists": sfn.JsonPath_stringAt(jsii.String("$.product.availability")),
			"StaticValue": jsii.String("foo"),
		},
	},
})

SQS

Step Functions supports Amazon SQS

Send Message

You can call the SendMessage API from a Task state to send a message to an SQS queue.

queue := sqs.NewQueue(this, jsii.String("Queue"))

// Use a field from the execution data as message.
task1 := tasks.NewSqsSendMessage(this, jsii.String("Send1"), &SqsSendMessageProps{
	Queue: Queue,
	MessageBody: sfn.TaskInput_FromJsonPathAt(jsii.String("$.message")),
})

// Combine a field from the execution data with
// a literal object.
task2 := tasks.NewSqsSendMessage(this, jsii.String("Send2"), &SqsSendMessageProps{
	Queue: Queue,
	MessageBody: sfn.TaskInput_FromObject(map[string]interface{}{
		"field1": jsii.String("somedata"),
		"field2": sfn.JsonPath_stringAt(jsii.String("$.field2")),
	}),
})

# Functions

AcceleratorClass_EIA1

No description provided by the author

AcceleratorClass_EIA2

No description provided by the author

AcceleratorClass_Of

Custom AcceleratorType.

AcceleratorType_Of

AcceleratorType.

AthenaGetQueryExecution_FilterNextables

Return only the states that allow chaining from an array of states.

AthenaGetQueryExecution_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

AthenaGetQueryExecution_FindReachableStates

Find the set of states reachable through transitions from the given start state.

AthenaGetQueryExecution_IsConstruct

Checks if `x` is a construct.

AthenaGetQueryExecution_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

AthenaGetQueryResults_FilterNextables

Return only the states that allow chaining from an array of states.

AthenaGetQueryResults_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

AthenaGetQueryResults_FindReachableStates

Find the set of states reachable through transitions from the given start state.

AthenaGetQueryResults_IsConstruct

Checks if `x` is a construct.

AthenaGetQueryResults_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

AthenaStartQueryExecution_FilterNextables

Return only the states that allow chaining from an array of states.

AthenaStartQueryExecution_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

AthenaStartQueryExecution_FindReachableStates

Find the set of states reachable through transitions from the given start state.

AthenaStartQueryExecution_IsConstruct

Checks if `x` is a construct.

AthenaStartQueryExecution_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

AthenaStopQueryExecution_FilterNextables

Return only the states that allow chaining from an array of states.

AthenaStopQueryExecution_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

AthenaStopQueryExecution_FindReachableStates

Find the set of states reachable through transitions from the given start state.

AthenaStopQueryExecution_IsConstruct

Checks if `x` is a construct.

AthenaStopQueryExecution_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

BatchSubmitJob_FilterNextables

Return only the states that allow chaining from an array of states.

BatchSubmitJob_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

BatchSubmitJob_FindReachableStates

Find the set of states reachable through transitions from the given start state.

BatchSubmitJob_IsConstruct

Checks if `x` is a construct.

BatchSubmitJob_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

BedrockInvokeModel_FilterNextables

Return only the states that allow chaining from an array of states.

BedrockInvokeModel_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

BedrockInvokeModel_FindReachableStates

Find the set of states reachable through transitions from the given start state.

BedrockInvokeModel_IsConstruct

Checks if `x` is a construct.

BedrockInvokeModel_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

CallApiGatewayHttpApiEndpoint_FilterNextables

Return only the states that allow chaining from an array of states.

CallApiGatewayHttpApiEndpoint_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

CallApiGatewayHttpApiEndpoint_FindReachableStates

Find the set of states reachable through transitions from the given start state.

CallApiGatewayHttpApiEndpoint_IsConstruct

Checks if `x` is a construct.

CallApiGatewayHttpApiEndpoint_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

CallApiGatewayRestApiEndpoint_FilterNextables

Return only the states that allow chaining from an array of states.

CallApiGatewayRestApiEndpoint_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

CallApiGatewayRestApiEndpoint_FindReachableStates

Find the set of states reachable through transitions from the given start state.

CallApiGatewayRestApiEndpoint_IsConstruct

Checks if `x` is a construct.

CallApiGatewayRestApiEndpoint_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

CallAwsService_FilterNextables

Return only the states that allow chaining from an array of states.

CallAwsService_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

CallAwsService_FindReachableStates

Find the set of states reachable through transitions from the given start state.

CallAwsService_IsConstruct

Checks if `x` is a construct.

CallAwsService_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

CallAwsServiceCrossRegion_FilterNextables

Return only the states that allow chaining from an array of states.

CallAwsServiceCrossRegion_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

CallAwsServiceCrossRegion_FindReachableStates

Find the set of states reachable through transitions from the given start state.

CallAwsServiceCrossRegion_IsConstruct

Checks if `x` is a construct.

CallAwsServiceCrossRegion_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

Classification_SPARK

No description provided by the author

Classification_SPARK_DEFAULTS

No description provided by the author

Classification_SPARK_ENV

No description provided by the author

Classification_SPARK_HIVE_SITE

No description provided by the author

Classification_SPARK_LOG4J

No description provided by the author

Classification_SPARK_METRICS

No description provided by the author

CodeBuildStartBuild_FilterNextables

Return only the states that allow chaining from an array of states.

CodeBuildStartBuild_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

CodeBuildStartBuild_FindReachableStates

Find the set of states reachable through transitions from the given start state.

CodeBuildStartBuild_IsConstruct

Checks if `x` is a construct.

CodeBuildStartBuild_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

CodeBuildStartBuildBatch_FilterNextables

Return only the states that allow chaining from an array of states.

CodeBuildStartBuildBatch_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

CodeBuildStartBuildBatch_FindReachableStates

Find the set of states reachable through transitions from the given start state.

CodeBuildStartBuildBatch_IsConstruct

Checks if `x` is a construct.

CodeBuildStartBuildBatch_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

DockerImage_FromAsset

Reference a Docker image that is provided as an Asset in the current app.

DockerImage_FromEcrRepository

Reference a Docker image stored in an ECR repository.

DockerImage_FromJsonExpression

Reference a Docker image which URI is obtained from the task's input.

DockerImage_FromRegistry

Reference a Docker image by it's URI.

DynamoAttributeValue_BooleanFromJsonPath

Sets an attribute of type Boolean from state input through Json path.

DynamoAttributeValue_FromBinary

Sets an attribute of type Binary.

DynamoAttributeValue_FromBinarySet

Sets an attribute of type Binary Set.

DynamoAttributeValue_FromBoolean

Sets an attribute of type Boolean.

DynamoAttributeValue_FromList

Sets an attribute of type List.

DynamoAttributeValue_FromMap

Sets an attribute of type Map.

DynamoAttributeValue_FromNull

Sets an attribute of type Null.

DynamoAttributeValue_FromNumber

Sets a literal number.

DynamoAttributeValue_FromNumberSet

Sets an attribute of type Number Set.

DynamoAttributeValue_FromString

Sets an attribute of type String.

DynamoAttributeValue_FromStringSet

Sets an attribute of type String Set.

DynamoAttributeValue_ListFromJsonPath

Sets an attribute of type List.

DynamoAttributeValue_MapFromJsonPath

Sets an attribute of type Map.

DynamoAttributeValue_NumberFromString

Sets an attribute of type Number.

DynamoAttributeValue_NumberSetFromStrings

Sets an attribute of type Number Set.

DynamoDeleteItem_FilterNextables

Return only the states that allow chaining from an array of states.

DynamoDeleteItem_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

DynamoDeleteItem_FindReachableStates

Find the set of states reachable through transitions from the given start state.

DynamoDeleteItem_IsConstruct

Checks if `x` is a construct.

DynamoDeleteItem_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

DynamoGetItem_FilterNextables

Return only the states that allow chaining from an array of states.

DynamoGetItem_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

DynamoGetItem_FindReachableStates

Find the set of states reachable through transitions from the given start state.

DynamoGetItem_IsConstruct

Checks if `x` is a construct.

DynamoGetItem_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

DynamoPutItem_FilterNextables

Return only the states that allow chaining from an array of states.

DynamoPutItem_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

DynamoPutItem_FindReachableStates

Find the set of states reachable through transitions from the given start state.

DynamoPutItem_IsConstruct

Checks if `x` is a construct.

DynamoPutItem_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

DynamoUpdateItem_FilterNextables

Return only the states that allow chaining from an array of states.

DynamoUpdateItem_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

DynamoUpdateItem_FindReachableStates

Find the set of states reachable through transitions from the given start state.

DynamoUpdateItem_IsConstruct

Checks if `x` is a construct.

DynamoUpdateItem_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EcsRunTask_FilterNextables

Return only the states that allow chaining from an array of states.

EcsRunTask_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EcsRunTask_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EcsRunTask_IsConstruct

Checks if `x` is a construct.

EcsRunTask_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EksCall_FilterNextables

Return only the states that allow chaining from an array of states.

EksCall_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EksCall_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EksCall_IsConstruct

Checks if `x` is a construct.

EksCall_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EksClusterInput_FromCluster

Specify an existing EKS Cluster as the name for this Cluster.

EksClusterInput_FromTaskInput

Specify a Task Input as the name for this Cluster.

EmrAddStep_FilterNextables

Return only the states that allow chaining from an array of states.

EmrAddStep_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrAddStep_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrAddStep_IsConstruct

Checks if `x` is a construct.

EmrAddStep_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EmrCancelStep_FilterNextables

Return only the states that allow chaining from an array of states.

EmrCancelStep_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrCancelStep_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrCancelStep_IsConstruct

Checks if `x` is a construct.

EmrCancelStep_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EmrContainersCreateVirtualCluster_FilterNextables

Return only the states that allow chaining from an array of states.

EmrContainersCreateVirtualCluster_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrContainersCreateVirtualCluster_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrContainersCreateVirtualCluster_IsConstruct

Checks if `x` is a construct.

EmrContainersCreateVirtualCluster_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EmrContainersDeleteVirtualCluster_FilterNextables

Return only the states that allow chaining from an array of states.

EmrContainersDeleteVirtualCluster_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrContainersDeleteVirtualCluster_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrContainersDeleteVirtualCluster_IsConstruct

Checks if `x` is a construct.

EmrContainersDeleteVirtualCluster_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EmrContainersStartJobRun_FilterNextables

Return only the states that allow chaining from an array of states.

EmrContainersStartJobRun_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrContainersStartJobRun_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrContainersStartJobRun_IsConstruct

Checks if `x` is a construct.

EmrContainersStartJobRun_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EmrCreateCluster_FilterNextables

Return only the states that allow chaining from an array of states.

EmrCreateCluster_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrCreateCluster_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrCreateCluster_IsConstruct

Checks if `x` is a construct.

EmrCreateCluster_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EmrModifyInstanceFleetByName_FilterNextables

Return only the states that allow chaining from an array of states.

EmrModifyInstanceFleetByName_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrModifyInstanceFleetByName_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrModifyInstanceFleetByName_IsConstruct

Checks if `x` is a construct.

EmrModifyInstanceFleetByName_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EmrModifyInstanceGroupByName_FilterNextables

Return only the states that allow chaining from an array of states.

EmrModifyInstanceGroupByName_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrModifyInstanceGroupByName_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrModifyInstanceGroupByName_IsConstruct

Checks if `x` is a construct.

EmrModifyInstanceGroupByName_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EmrSetClusterTerminationProtection_FilterNextables

Return only the states that allow chaining from an array of states.

EmrSetClusterTerminationProtection_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrSetClusterTerminationProtection_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrSetClusterTerminationProtection_IsConstruct

Checks if `x` is a construct.

EmrSetClusterTerminationProtection_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EmrTerminateCluster_FilterNextables

Return only the states that allow chaining from an array of states.

EmrTerminateCluster_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EmrTerminateCluster_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EmrTerminateCluster_IsConstruct

Checks if `x` is a construct.

EmrTerminateCluster_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EvaluateExpression_FilterNextables

Return only the states that allow chaining from an array of states.

EvaluateExpression_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EvaluateExpression_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EvaluateExpression_IsConstruct

Checks if `x` is a construct.

EvaluateExpression_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

EventBridgePutEvents_FilterNextables

Return only the states that allow chaining from an array of states.

EventBridgePutEvents_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

EventBridgePutEvents_FindReachableStates

Find the set of states reachable through transitions from the given start state.

EventBridgePutEvents_IsConstruct

Checks if `x` is a construct.

EventBridgePutEvents_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

GlueDataBrewStartJobRun_FilterNextables

Return only the states that allow chaining from an array of states.

GlueDataBrewStartJobRun_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

GlueDataBrewStartJobRun_FindReachableStates

Find the set of states reachable through transitions from the given start state.

GlueDataBrewStartJobRun_IsConstruct

Checks if `x` is a construct.

GlueDataBrewStartJobRun_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

GlueStartCrawlerRun_FilterNextables

Return only the states that allow chaining from an array of states.

GlueStartCrawlerRun_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

GlueStartCrawlerRun_FindReachableStates

Find the set of states reachable through transitions from the given start state.

GlueStartCrawlerRun_IsConstruct

Checks if `x` is a construct.

GlueStartCrawlerRun_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

GlueStartJobRun_FilterNextables

Return only the states that allow chaining from an array of states.

GlueStartJobRun_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

GlueStartJobRun_FindReachableStates

Find the set of states reachable through transitions from the given start state.

GlueStartJobRun_IsConstruct

Checks if `x` is a construct.

GlueStartJobRun_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

Guardrail_Enable

Enable guardrail.

Guardrail_EnableDraft

Enable guardrail with DRAFT version.

HttpInvoke_FilterNextables

Return only the states that allow chaining from an array of states.

HttpInvoke_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

HttpInvoke_FindReachableStates

Find the set of states reachable through transitions from the given start state.

HttpInvoke_IsConstruct

Checks if `x` is a construct.

HttpInvoke_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

LambdaInvoke_FilterNextables

Return only the states that allow chaining from an array of states.

LambdaInvoke_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

LambdaInvoke_FindReachableStates

Find the set of states reachable through transitions from the given start state.

LambdaInvoke_IsConstruct

Checks if `x` is a construct.

LambdaInvoke_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

MediaConvertCreateJob_FilterNextables

Return only the states that allow chaining from an array of states.

MediaConvertCreateJob_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

MediaConvertCreateJob_FindReachableStates

Find the set of states reachable through transitions from the given start state.

MediaConvertCreateJob_IsConstruct

Checks if `x` is a construct.

MediaConvertCreateJob_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

NewAcceleratorType

No description provided by the author

NewAcceleratorType_Override

No description provided by the author

NewAthenaGetQueryExecution

No description provided by the author

NewAthenaGetQueryExecution_Override

No description provided by the author

NewAthenaGetQueryResults

No description provided by the author

NewAthenaGetQueryResults_Override

No description provided by the author

NewAthenaStartQueryExecution

No description provided by the author

NewAthenaStartQueryExecution_Override

No description provided by the author

NewAthenaStopQueryExecution

No description provided by the author

NewAthenaStopQueryExecution_Override

No description provided by the author

NewBatchSubmitJob

No description provided by the author

NewBatchSubmitJob_Override

No description provided by the author

NewBedrockInvokeModel

No description provided by the author

NewBedrockInvokeModel_Override

No description provided by the author

NewCallApiGatewayHttpApiEndpoint

No description provided by the author

NewCallApiGatewayHttpApiEndpoint_Override

No description provided by the author

NewCallApiGatewayRestApiEndpoint

No description provided by the author

NewCallApiGatewayRestApiEndpoint_Override

No description provided by the author

NewCallAwsService

No description provided by the author

NewCallAwsService_Override

No description provided by the author

NewCallAwsServiceCrossRegion

No description provided by the author

NewCallAwsServiceCrossRegion_Override

No description provided by the author

NewClassification

Creates a new Classification.

NewClassification_Override

Creates a new Classification.

NewCodeBuildStartBuild

No description provided by the author

NewCodeBuildStartBuild_Override

No description provided by the author

NewCodeBuildStartBuildBatch

No description provided by the author

NewCodeBuildStartBuildBatch_Override

No description provided by the author

NewContainerDefinition

No description provided by the author

NewContainerDefinition_Override

No description provided by the author

NewDockerImage_Override

No description provided by the author

NewDynamoDeleteItem

No description provided by the author

NewDynamoDeleteItem_Override

No description provided by the author

NewDynamoGetItem

No description provided by the author

NewDynamoGetItem_Override

No description provided by the author

NewDynamoProjectionExpression

No description provided by the author

NewDynamoProjectionExpression_Override

No description provided by the author

NewDynamoPutItem

No description provided by the author

NewDynamoPutItem_Override

No description provided by the author

NewDynamoUpdateItem

No description provided by the author

NewDynamoUpdateItem_Override

No description provided by the author

NewEcsEc2LaunchTarget

No description provided by the author

NewEcsEc2LaunchTarget_Override

No description provided by the author

NewEcsFargateLaunchTarget

No description provided by the author

NewEcsFargateLaunchTarget_Override

No description provided by the author

NewEcsRunTask

No description provided by the author

NewEcsRunTask_Override

No description provided by the author

NewEksCall

No description provided by the author

NewEksCall_Override

No description provided by the author

NewEmrAddStep

No description provided by the author

NewEmrAddStep_Override

No description provided by the author

NewEmrCancelStep

No description provided by the author

NewEmrCancelStep_Override

No description provided by the author

NewEmrContainersCreateVirtualCluster

No description provided by the author

NewEmrContainersCreateVirtualCluster_Override

No description provided by the author

NewEmrContainersDeleteVirtualCluster

No description provided by the author

NewEmrContainersDeleteVirtualCluster_Override

No description provided by the author

NewEmrContainersStartJobRun

No description provided by the author

NewEmrContainersStartJobRun_Override

No description provided by the author

NewEmrCreateCluster

No description provided by the author

NewEmrCreateCluster_Override

No description provided by the author

NewEmrModifyInstanceFleetByName

No description provided by the author

NewEmrModifyInstanceFleetByName_Override

No description provided by the author

NewEmrModifyInstanceGroupByName

No description provided by the author

NewEmrModifyInstanceGroupByName_Override

No description provided by the author

NewEmrSetClusterTerminationProtection

No description provided by the author

NewEmrSetClusterTerminationProtection_Override

No description provided by the author

NewEmrTerminateCluster

No description provided by the author

NewEmrTerminateCluster_Override

No description provided by the author

NewEvaluateExpression

No description provided by the author

NewEvaluateExpression_Override

No description provided by the author

NewEventBridgePutEvents

No description provided by the author

NewEventBridgePutEvents_Override

No description provided by the author

NewGlueDataBrewStartJobRun

No description provided by the author

NewGlueDataBrewStartJobRun_Override

No description provided by the author

NewGlueStartCrawlerRun

No description provided by the author

NewGlueStartCrawlerRun_Override

No description provided by the author

NewGlueStartJobRun

No description provided by the author

NewGlueStartJobRun_Override

No description provided by the author

NewHttpInvoke

No description provided by the author

NewHttpInvoke_Override

No description provided by the author

NewLambdaInvoke

No description provided by the author

NewLambdaInvoke_Override

No description provided by the author

NewMediaConvertCreateJob

No description provided by the author

NewMediaConvertCreateJob_Override

No description provided by the author

NewReleaseLabel

Initializes the label string.

NewReleaseLabel_Override

Initializes the label string.

NewS3Location_Override

No description provided by the author

NewSageMakerCreateEndpoint

No description provided by the author

NewSageMakerCreateEndpoint_Override

No description provided by the author

NewSageMakerCreateEndpointConfig

No description provided by the author

NewSageMakerCreateEndpointConfig_Override

No description provided by the author

NewSageMakerCreateModel

No description provided by the author

NewSageMakerCreateModel_Override

No description provided by the author

NewSageMakerCreateTrainingJob

No description provided by the author

NewSageMakerCreateTrainingJob_Override

No description provided by the author

NewSageMakerCreateTransformJob

No description provided by the author

NewSageMakerCreateTransformJob_Override

No description provided by the author

NewSageMakerUpdateEndpoint

No description provided by the author

NewSageMakerUpdateEndpoint_Override

No description provided by the author

NewSnsPublish

No description provided by the author

NewSnsPublish_Override

No description provided by the author

NewSqsSendMessage

No description provided by the author

NewSqsSendMessage_Override

No description provided by the author

NewStepFunctionsInvokeActivity

No description provided by the author

NewStepFunctionsInvokeActivity_Override

No description provided by the author

NewStepFunctionsStartExecution

No description provided by the author

NewStepFunctionsStartExecution_Override

No description provided by the author

ReleaseLabel_EMR_5_32_0

No description provided by the author

ReleaseLabel_EMR_5_33_0

No description provided by the author

ReleaseLabel_EMR_6_2_0

No description provided by the author

ReleaseLabel_EMR_6_3_0

No description provided by the author

S3Location_FromBucket

An `IS3Location` built with a determined bucket and key prefix.

S3Location_FromJsonExpression

An `IS3Location` determined fully by a JSON Path from the task input.

SageMakerCreateEndpoint_FilterNextables

Return only the states that allow chaining from an array of states.

SageMakerCreateEndpoint_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

SageMakerCreateEndpoint_FindReachableStates

Find the set of states reachable through transitions from the given start state.

SageMakerCreateEndpoint_IsConstruct

Checks if `x` is a construct.

SageMakerCreateEndpoint_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

SageMakerCreateEndpointConfig_FilterNextables

Return only the states that allow chaining from an array of states.

SageMakerCreateEndpointConfig_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

SageMakerCreateEndpointConfig_FindReachableStates

Find the set of states reachable through transitions from the given start state.

SageMakerCreateEndpointConfig_IsConstruct

Checks if `x` is a construct.

SageMakerCreateEndpointConfig_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

SageMakerCreateModel_FilterNextables

Return only the states that allow chaining from an array of states.

SageMakerCreateModel_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

SageMakerCreateModel_FindReachableStates

Find the set of states reachable through transitions from the given start state.

SageMakerCreateModel_IsConstruct

Checks if `x` is a construct.

SageMakerCreateModel_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

SageMakerCreateTrainingJob_FilterNextables

Return only the states that allow chaining from an array of states.

SageMakerCreateTrainingJob_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

SageMakerCreateTrainingJob_FindReachableStates

Find the set of states reachable through transitions from the given start state.

SageMakerCreateTrainingJob_IsConstruct

Checks if `x` is a construct.

SageMakerCreateTrainingJob_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

SageMakerCreateTransformJob_FilterNextables

Return only the states that allow chaining from an array of states.

SageMakerCreateTransformJob_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

SageMakerCreateTransformJob_FindReachableStates

Find the set of states reachable through transitions from the given start state.

SageMakerCreateTransformJob_IsConstruct

Checks if `x` is a construct.

SageMakerCreateTransformJob_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

SageMakerUpdateEndpoint_FilterNextables

Return only the states that allow chaining from an array of states.

SageMakerUpdateEndpoint_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

SageMakerUpdateEndpoint_FindReachableStates

Find the set of states reachable through transitions from the given start state.

SageMakerUpdateEndpoint_IsConstruct

Checks if `x` is a construct.

SageMakerUpdateEndpoint_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

SnsPublish_FilterNextables

Return only the states that allow chaining from an array of states.

SnsPublish_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

SnsPublish_FindReachableStates

Find the set of states reachable through transitions from the given start state.

SnsPublish_IsConstruct

Checks if `x` is a construct.

SnsPublish_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

SqsSendMessage_FilterNextables

Return only the states that allow chaining from an array of states.

SqsSendMessage_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

SqsSendMessage_FindReachableStates

Find the set of states reachable through transitions from the given start state.

SqsSendMessage_IsConstruct

Checks if `x` is a construct.

SqsSendMessage_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

StepFunctionsInvokeActivity_FilterNextables

Return only the states that allow chaining from an array of states.

StepFunctionsInvokeActivity_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

StepFunctionsInvokeActivity_FindReachableStates

Find the set of states reachable through transitions from the given start state.

StepFunctionsInvokeActivity_IsConstruct

Checks if `x` is a construct.

StepFunctionsInvokeActivity_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

StepFunctionsStartExecution_FilterNextables

Return only the states that allow chaining from an array of states.

StepFunctionsStartExecution_FindReachableEndStates

Find the set of end states states reachable through transitions from the given start state.

StepFunctionsStartExecution_FindReachableStates

Find the set of states reachable through transitions from the given start state.

StepFunctionsStartExecution_IsConstruct

Checks if `x` is a construct.

StepFunctionsStartExecution_PrefixStates

Add a prefix to the stateId of all States found in a construct tree.

VirtualClusterInput_FromTaskInput

Input for a virtualClusterId from a Task Input.

VirtualClusterInput_FromVirtualClusterId

Input for virtualClusterId from a literal string.

# Constants

ActionOnFailure_CANCEL_AND_WAIT

Cancel Step execution and enter WAITING state.

ActionOnFailure_CONTINUE

Continue to the next Step.

ActionOnFailure_TERMINATE_CLUSTER

Terminate the Cluster on Step Failure.

AssembleWith_LINE

Add a newline character at the end of every transformed record.

AssembleWith_NONE

Concatenate the results in binary format.

AuthType_IAM_ROLE

Use the IAM role associated with the current state machine for authorization.

AuthType_NO_AUTH

Call the API direclty with no authorization method.

AuthType_RESOURCE_POLICY

Use the resource policy of the API for authorization.

BatchStrategy_MULTI_RECORD

Fits multiple records in a mini-batch.

BatchStrategy_SINGLE_RECORD

Use a single record when making an invocation request.

CompressionType_GZIP

Gzip compression type.

CompressionType_NONE

None compression type.

DynamoConsumedCapacity_INDEXES

The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

DynamoConsumedCapacity_NONE

No ConsumedCapacity details are included in the response.

DynamoConsumedCapacity_TOTAL

The response includes only the aggregate ConsumedCapacity for the operation.

DynamoItemCollectionMetrics_NONE

If set to NONE, no statistics are returned.

DynamoItemCollectionMetrics_SIZE

If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation.

DynamoReturnValues_ALL_NEW

Returns all of the attributes of the item.

DynamoReturnValues_ALL_OLD

Returns all of the attributes of the item.

DynamoReturnValues_NONE

Nothing is returned.

DynamoReturnValues_UPDATED_NEW

Returns only the updated attributes.

DynamoReturnValues_UPDATED_OLD

Returns only the updated attributes.

EmrCreateCluster_CloudWatchAlarmComparisonOperator_GREATER_THAN

GREATER_THAN.

EmrCreateCluster_CloudWatchAlarmComparisonOperator_GREATER_THAN_OR_EQUAL

GREATER_THAN_OR_EQUAL.

EmrCreateCluster_CloudWatchAlarmComparisonOperator_LESS_THAN

LESS_THAN.

EmrCreateCluster_CloudWatchAlarmComparisonOperator_LESS_THAN_OR_EQUAL

LESS_THAN_OR_EQUAL.

EmrCreateCluster_CloudWatchAlarmStatistic_AVERAGE

AVERAGE.

EmrCreateCluster_CloudWatchAlarmStatistic_MAXIMUM

MAXIMUM.

EmrCreateCluster_CloudWatchAlarmStatistic_MINIMUM

MINIMUM.

EmrCreateCluster_CloudWatchAlarmStatistic_SAMPLE_COUNT

SAMPLE_COUNT.

EmrCreateCluster_CloudWatchAlarmStatistic_SUM

SUM.

EmrCreateCluster_CloudWatchAlarmUnit_BITS

BITS.

EmrCreateCluster_CloudWatchAlarmUnit_BITS_PER_SECOND

BITS_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_BYTES

BYTES.

EmrCreateCluster_CloudWatchAlarmUnit_BYTES_PER_SECOND

BYTES_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_COUNT

COUNT.

EmrCreateCluster_CloudWatchAlarmUnit_COUNT_PER_SECOND

COUNT_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_GIGA_BITS

GIGA_BITS.

EmrCreateCluster_CloudWatchAlarmUnit_GIGA_BITS_PER_SECOND

GIGA_BITS_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_GIGA_BYTES

GIGA_BYTES.

EmrCreateCluster_CloudWatchAlarmUnit_GIGA_BYTES_PER_SECOND

GIGA_BYTES_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_KILO_BITS

KILO_BITS.

EmrCreateCluster_CloudWatchAlarmUnit_KILO_BITS_PER_SECOND

KILO_BITS_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_KILO_BYTES

KILO_BYTES.

EmrCreateCluster_CloudWatchAlarmUnit_KILO_BYTES_PER_SECOND

KILO_BYTES_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_MEGA_BITS

MEGA_BITS.

EmrCreateCluster_CloudWatchAlarmUnit_MEGA_BITS_PER_SECOND

MEGA_BITS_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_MEGA_BYTES

MEGA_BYTES.

EmrCreateCluster_CloudWatchAlarmUnit_MEGA_BYTES_PER_SECOND

MEGA_BYTES_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_MICRO_SECONDS

MICRO_SECONDS.

EmrCreateCluster_CloudWatchAlarmUnit_MILLI_SECONDS

MILLI_SECONDS.

EmrCreateCluster_CloudWatchAlarmUnit_NONE

NONE.

EmrCreateCluster_CloudWatchAlarmUnit_PERCENT

PERCENT.

EmrCreateCluster_CloudWatchAlarmUnit_SECONDS

SECONDS.

EmrCreateCluster_CloudWatchAlarmUnit_TERA_BITS

TERA_BITS.

EmrCreateCluster_CloudWatchAlarmUnit_TERA_BITS_PER_SECOND

TERA_BITS_PER_SECOND.

EmrCreateCluster_CloudWatchAlarmUnit_TERA_BYTES

TERA_BYTES.

EmrCreateCluster_CloudWatchAlarmUnit_TERA_BYTES_PER_SECOND

TERA_BYTES_PER_SECOND.

EmrCreateCluster_EbsBlockDeviceVolumeType_GP2

gp2 Volume Type.

EmrCreateCluster_EbsBlockDeviceVolumeType_GP3

gp3 Volume Type.

EmrCreateCluster_EbsBlockDeviceVolumeType_IO1

io1 Volume Type.

EmrCreateCluster_EbsBlockDeviceVolumeType_SC1

sc1 Volume Type.

EmrCreateCluster_EbsBlockDeviceVolumeType_ST1

st1 Volume Type.

EmrCreateCluster_EbsBlockDeviceVolumeType_STANDARD

Standard Volume Type.

EmrCreateCluster_EmrClusterScaleDownBehavior_TERMINATE_AT_INSTANCE_HOUR

Indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted.

EmrCreateCluster_EmrClusterScaleDownBehavior_TERMINATE_AT_TASK_COMPLETION

Indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary.

EmrCreateCluster_InstanceMarket_ON_DEMAND

On Demand Instance.

EmrCreateCluster_InstanceMarket_SPOT

Spot Instance.

EmrCreateCluster_InstanceRoleType_CORE

Core Node.

EmrCreateCluster_InstanceRoleType_MASTER

Master Node.

EmrCreateCluster_InstanceRoleType_TASK

Task Node.

EmrCreateCluster_OnDemandAllocationStrategy_LOWEST_PRICE

Lowest-price, which launches instances from the lowest priced pool that has available capacity.

EmrCreateCluster_ScalingAdjustmentType_CHANGE_IN_CAPACITY

CHANGE_IN_CAPACITY.

EmrCreateCluster_ScalingAdjustmentType_EXACT_CAPACITY

EXACT_CAPACITY.

EmrCreateCluster_ScalingAdjustmentType_PERCENT_CHANGE_IN_CAPACITY

PERCENT_CHANGE_IN_CAPACITY.

EmrCreateCluster_SpotAllocationStrategy_CAPACITY_OPTIMIZED

Capacity-optimized, which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

EmrCreateCluster_SpotAllocationStrategy_DIVERSIFIED

Diversified, which launches instances across all Spot capacity pools.

EmrCreateCluster_SpotAllocationStrategy_LOWEST_PRICE

Lowest-price, which launches instances from the lowest priced pool that has available capacity.

EmrCreateCluster_SpotAllocationStrategy_PRICE_CAPACITY_OPTIMIZED

Price-capacity-optimized, which launches instances from Spot Instance pools with the highest capacity availability for the number of instances that are launching.

EmrCreateCluster_SpotTimeoutAction_SWITCH_TO_ON_DEMAND

SWITCH_TO_ON_DEMAND.

EmrCreateCluster_SpotTimeoutAction_TERMINATE_CLUSTER

TERMINATE_CLUSTER.

EncryptionOption_CLIENT_SIDE_KMS

Client-side encryption (CSE) with an AWS KMS key managed by the account owner.

EncryptionOption_KMS

Server-side encryption (SSE) with an AWS KMS key managed by the account owner.

EncryptionOption_S3_MANAGED

Server side encryption (SSE) with an Amazon S3-managed key.

ExecutionClass_FLEX

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

ExecutionClass_STANDARD

The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

HttpMethod_DELETE

Delete the resource at the specified endpoint.

HttpMethod_GET

Retreive data from a server at the specified resource.

HttpMethod_HEAD

Retreive data from a server at the specified resource without the response body.

HttpMethod_OPTIONS

Return data describing what other methods and operations the server supports.

HttpMethod_PATCH

Apply partial modifications to the resource.

HttpMethod_POST

Send data to the API endpoint to create or udpate a resource.

HttpMethod_PUT

Send data to the API endpoint to update or create a resource.

HttpMethods_DELETE

Delete the resource at the specified endpoint.

HttpMethods_GET

Retrieve data from a server at the specified resource.

HttpMethods_HEAD

Retrieve data from a server at the specified resource without the response body.

HttpMethods_PATCH

Apply partial modifications to the resource.

HttpMethods_POST

Send data to the API endpoint to create or update a resource.

HttpMethods_PUT

Send data to the API endpoint to update or create a resource.

InputMode_FAST_FILE

FastFile mode.

InputMode_FILE

File mode.

InputMode_PIPE

Pipe mode.

LambdaInvocationType_DRY_RUN

Validate parameter values and verify that the user or role has permission to invoke the function.

LambdaInvocationType_EVENT

Invoke the function asynchronously.

LambdaInvocationType_REQUEST_RESPONSE

Invoke the function synchronously.

MessageAttributeDataType_BINARY

Binary type attributes can store any binary data.

MessageAttributeDataType_NUMBER

Numbers are positive or negative integers or floating-point numbers.

MessageAttributeDataType_STRING

Strings are Unicode with UTF-8 binary encoding.

MessageAttributeDataType_STRING_ARRAY

An array, formatted as a string.

Mode_MULTI_MODEL

Container hosts multiple models.

Mode_SINGLE_MODEL

Container hosts a single model.

RecordWrapperType_NONE

None record wrapper type.

RecordWrapperType_RECORD_IO

RecordIO record wrapper type.

S3DataDistributionType_FULLY_REPLICATED

Fully replicated S3 Data Distribution Type.

S3DataDistributionType_SHARDED_BY_S3_KEY

Sharded By S3 Key Data Distribution Type.

S3DataType_AUGMENTED_MANIFEST_FILE

Augmented Manifest File Data Type.

S3DataType_MANIFEST_FILE

Manifest File Data Type.

S3DataType_S3_PREFIX

S3 Prefix Data Type.

SplitType_LINE

Split records on a newline character boundary.

SplitType_NONE

Input data files are not split,.

SplitType_RECORD_IO

Split using MXNet RecordIO format.

SplitType_TF_RECORD

Split using TensorFlow TFRecord format.

URLEncodingFormat_BRACKETS

Encode arrays using brackets.

URLEncodingFormat_COMMAS

Encode arrays using commas.

URLEncodingFormat_DEFAULT

Apply the default URL encoding style (INDICES).

URLEncodingFormat_INDICES

Encode arrays using the index value.

URLEncodingFormat_NONE

Do not apply URL encoding.

URLEncodingFormat_REPEAT

Repeat key for each item in the array.

WorkerType_G_025X

Each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker.

WorkerType_G_1X

Each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker.

WorkerType_G_2X

Each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker.

WorkerType_G_4X

Each worker maps to 4 DPU (16 vCPU, 64 GB of memory, 256 GB disk), and provides 1 executor per worker.

WorkerType_G_8X

Each worker maps to 8 DPU (32 vCPU, 128 GB of memory, 512 GB disk), and provides 1 executor per worker.

WorkerType_STANDARD

Each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

WorkerType_Z_2X

Each worker maps to 2 high-memory DPU [M-DPU] (8 vCPU, 64 GB of memory, 128 GB disk).

# Structs

AlgorithmSpecification

Specify the training algorithm and algorithm-specific metadata.

ApplicationConfiguration

A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS.

AthenaGetQueryExecutionProps

Properties for getting a Query Execution.

AthenaGetQueryResultsProps

Properties for getting a Query Results.

AthenaStartQueryExecutionProps

Properties for starting a Query Execution.

AthenaStopQueryExecutionProps

Properties for stoping a Query Execution.

BatchContainerOverrides

The overrides that should be sent to a container.

BatchJobDependency

An object representing an AWS Batch job dependency.

BatchSubmitJobProps

Properties for RunBatchJob.

BedrockInvokeModelInputProps

Location to retrieve the input data, prior to calling Bedrock InvokeModel.

BedrockInvokeModelOutputProps

Location where the Bedrock InvokeModel API response is written.

BedrockInvokeModelProps

Properties for invoking a Bedrock Model.

CallApiGatewayEndpointBaseProps

Base CallApiGatewayEdnpoint Task Props.

CallApiGatewayHttpApiEndpointProps

Properties for calling an HTTP API Endpoint.

CallApiGatewayRestApiEndpointProps

Properties for calling an REST API Endpoint.

CallAwsServiceCrossRegionProps

Properties for calling an AWS service's API action from your state machine across regions.

CallAwsServiceProps

Properties for calling an AWS service's API action from your state machine.

Channel

Describes the training, validation or test dataset and the Amazon S3 location where it is stored.

CodeBuildStartBuildBatchProps

Properties for CodeBuildStartBuildBatch.

CodeBuildStartBuildProps

Properties for CodeBuildStartBuild.

CommonEcsRunTaskProps

Basic properties for ECS Tasks.

ContainerDefinitionConfig

Configuration options for the ContainerDefinition.

ContainerDefinitionOptions

Properties to define a ContainerDefinition.

ContainerOverride

A list of container overrides that specify the name of a container and the overrides it should receive.

ContainerOverrides

The overrides that should be sent to a container.

DataSource

Location of the channel data.

DockerImageConfig

Configuration for a using Docker image.

DynamoDeleteItemProps

Properties for DynamoDeleteItem Task.

DynamoGetItemProps

Properties for DynamoGetItem Task.

DynamoPutItemProps

Properties for DynamoPutItem Task.

DynamoUpdateItemProps

Properties for DynamoUpdateItem Task.

EcsEc2LaunchTargetOptions

Options to run an ECS task on EC2 in StepFunctions and ECS.

EcsFargateLaunchTargetOptions

Properties to define an ECS service.

EcsLaunchTargetConfig

Configuration options for the ECS launch type.

EcsRunTaskProps

Properties for ECS Tasks.

EksCallProps

Properties for calling a EKS endpoint with EksCall.

EmrAddStepProps

Properties for EmrAddStep.

EmrCancelStepProps

Properties for EmrCancelStep.

EmrContainersCreateVirtualClusterProps

Properties to define a EMR Containers CreateVirtualCluster Task on an EKS cluster.

EmrContainersDeleteVirtualClusterProps

Properties to define a EMR Containers DeleteVirtualCluster Task.

EmrContainersStartJobRunProps

The props for a EMR Containers StartJobRun Task.

EmrCreateCluster_ApplicationConfigProperty

Properties for the EMR Cluster Applications.

EmrCreateCluster_AutoScalingPolicyProperty

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.

EmrCreateCluster_BootstrapActionConfigProperty

Configuration of a bootstrap action.

EmrCreateCluster_CloudWatchAlarmDefinitionProperty

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered.

EmrCreateCluster_ConfigurationProperty

An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.

EmrCreateCluster_EbsBlockDeviceConfigProperty

Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.

EmrCreateCluster_EbsConfigurationProperty

The Amazon EBS configuration of a cluster instance.

EmrCreateCluster_InstanceFleetConfigProperty

The configuration that defines an instance fleet.

EmrCreateCluster_InstanceFleetProvisioningSpecificationsProperty

The launch specification for On-Demand and Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior, and allocation strategy.

EmrCreateCluster_InstanceGroupConfigProperty

Configuration defining a new instance group.

EmrCreateCluster_InstancesConfigProperty

A specification of the number and type of Amazon EC2 instances.

EmrCreateCluster_InstanceTypeConfigProperty

An instance type configuration for each instance type in an instance fleet, which determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities.

EmrCreateCluster_KerberosAttributesProperty

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.

EmrCreateCluster_MetricDimensionProperty

A CloudWatch dimension, which is specified using a Key (known as a Name in CloudWatch), Value pair.

EmrCreateCluster_OnDemandProvisioningSpecificationProperty

The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy.

EmrCreateCluster_PlacementTypeProperty

The Amazon EC2 Availability Zone configuration of the cluster (job flow).

EmrCreateCluster_ScalingActionProperty

The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.

EmrCreateCluster_ScalingConstraintsProperty

The upper and lower EC2 instance limits for an automatic scaling policy.

EmrCreateCluster_ScalingRuleProperty

A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments.

EmrCreateCluster_ScalingTriggerProperty

The conditions that trigger an automatic scaling activity and the definition of a CloudWatch metric alarm.

EmrCreateCluster_ScriptBootstrapActionConfigProperty

Configuration of the script to run during a bootstrap action.

EmrCreateCluster_SimpleScalingPolicyConfigurationProperty

An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.

EmrCreateCluster_SpotProvisioningSpecificationProperty

The launch specification for Spot instances in the instance fleet, which determines the defined duration and provisioning timeout behavior.

EmrCreateCluster_VolumeSpecificationProperty

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

EmrCreateClusterProps

Properties for EmrCreateCluster.

EmrModifyInstanceFleetByNameProps

Properties for EmrModifyInstanceFleetByName.

EmrModifyInstanceGroupByName_InstanceGroupModifyConfigProperty

Modify the size or configurations of an instance group.

EmrModifyInstanceGroupByName_InstanceResizePolicyProperty

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

EmrModifyInstanceGroupByName_ShrinkPolicyProperty

Policy for customizing shrink operations.

EmrModifyInstanceGroupByNameProps

Properties for EmrModifyInstanceGroupByName.

EmrSetClusterTerminationProtectionProps

Properties for EmrSetClusterTerminationProtection.

EmrTerminateClusterProps

Properties for EmrTerminateCluster.

EncryptionConfiguration

Encryption Configuration of the S3 bucket.

EvaluateExpressionProps

Properties for EvaluateExpression.

EventBridgePutEventsEntry

An entry to be sent to EventBridge.

EventBridgePutEventsProps

Properties for sending events with PutEvents.

GlueDataBrewStartJobRunProps

Properties for starting a job run with StartJobRun.

GlueStartCrawlerRunProps

Properties for starting an AWS Glue Crawler as a task.

GlueStartJobRunProps

Properties for starting an AWS Glue job as a task.

HttpInvokeProps

Properties for calling an external HTTP endpoint with HttpInvoke.

JobDependency

An object representing an AWS Batch job dependency.

JobDriver

Specify the driver that the EMR Containers job runs on.

LambdaInvokeProps

Properties for invoking a Lambda function with LambdaInvoke.

LaunchTargetBindOptions

Options for binding a launch target to an ECS run job task.

MediaConvertCreateJobProps

Properties for creating a MediaConvert Job.

MessageAttribute

A message attribute to add to the SNS message.

MetricDefinition

Specifies the metric name and regular expressions used to parse algorithm logs.

ModelClientOptions

Configures the timeout and maximum number of retries for processing a transform job invocation.

Monitoring

Configuration setting for monitoring.

OutputDataConfig

Configures the S3 bucket where SageMaker will save the result of model training.

ProductionVariant

Identifies a model that you want to host and the resources to deploy for hosting it.

QueryExecutionContext

Database and data catalog context in which the query execution occurs.

ResourceConfig

Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.

ResultConfiguration

Location of query result along with S3 bucket configuration.

S3DataSource

S3 location of the channel data.

S3LocationBindOptions

Options for binding an S3 Location.

S3LocationConfig

Stores information about the location of an object in Amazon S3.

SageMakerCreateEndpointConfigProps

Properties for creating an Amazon SageMaker endpoint configuration.

SageMakerCreateEndpointProps

Properties for creating an Amazon SageMaker endpoint.

SageMakerCreateModelProps

Properties for creating an Amazon SageMaker model.

SageMakerCreateTrainingJobProps

Properties for creating an Amazon SageMaker training job.

SageMakerCreateTransformJobProps

Properties for creating an Amazon SageMaker transform job task.

SageMakerUpdateEndpointProps

Properties for updating Amazon SageMaker endpoint.

ShuffleConfig

Configuration for a shuffle option for input data in a channel.

SnsPublishProps

Properties for publishing a message to an SNS topic.

SparkSubmitJobDriver

The information about job driver for Spark submit.

SqsSendMessageProps

Properties for sending a message to an SQS queue.

StepFunctionsInvokeActivityProps

Properties for invoking an Activity worker.

StepFunctionsStartExecutionProps

Properties for StartExecution.

StoppingCondition

Specifies a limit to how long a model training job can run.

TaskEnvironmentVariable

An environment variable to be set in the container run as a task.

TransformDataSource

S3 location of the input data that the model can consume.

TransformInput

Dataset to be transformed and the Amazon S3 location where it is stored.

TransformOutput

S3 location where you want Amazon SageMaker to save the results from the transform job.

TransformResources

ML compute instances for the transform job.

TransformS3DataSource

Location of the channel data.

VpcConfig

Specifies the VPC that you want your Amazon SageMaker training job to connect to.

WorkerConfigurationProperty

Properties for the worker configuration.

# Interfaces

AcceleratorClass

The generation of Elastic Inference (EI) instance.

AcceleratorType

The size of the Elastic Inference (EI) instance to use for the production variant.

AthenaGetQueryExecution

Get an Athena Query Execution as a Task.

AthenaGetQueryResults

Get an Athena Query Results as a Task.

AthenaStartQueryExecution

Start an Athena Query as a Task.

AthenaStopQueryExecution

Stop an Athena Query Execution as a Task.

BatchSubmitJob

Task to submits an AWS Batch job from a job definition.

BedrockInvokeModel

A Step Functions Task to invoke a model in Bedrock.

CallApiGatewayHttpApiEndpoint

Call HTTP API endpoint as a Task.

CallApiGatewayRestApiEndpoint

Call REST API endpoint as a Task.

CallAwsService

A StepFunctions task to call an AWS service API.

CallAwsServiceCrossRegion

A Step Functions task to call an AWS service API across regions.

Classification

The classification within a EMR Containers application configuration.

CodeBuildStartBuild

Start a CodeBuild Build as a task.

CodeBuildStartBuildBatch

Start a CodeBuild BatchBuild as a task.

ContainerDefinition

Describes the container, as part of model definition.

DockerImage

Creates `IDockerImage` instances.

DynamoAttributeValue

Represents the data for an attribute.

DynamoDeleteItem

A StepFunctions task to call DynamoDeleteItem.

DynamoGetItem

A StepFunctions task to call DynamoGetItem.

DynamoProjectionExpression

Class to generate projection expression.

DynamoPutItem

A StepFunctions task to call DynamoPutItem.

DynamoUpdateItem

A StepFunctions task to call DynamoUpdateItem.

EcsEc2LaunchTarget

Configuration for running an ECS task on EC2.

EcsFargateLaunchTarget

Configuration for running an ECS task on Fargate.

EcsRunTask

Run a Task on ECS or Fargate.

EksCall

Call a EKS endpoint as a Task.

EksClusterInput

Class that supports methods which return the EKS cluster name depending on input type.

EmrAddStep

A Step Functions Task to add a Step to an EMR Cluster.

EmrCancelStep

A Step Functions Task to to cancel a Step on an EMR Cluster.

EmrContainersCreateVirtualCluster

Task that creates an EMR Containers virtual cluster from an EKS cluster.

EmrContainersDeleteVirtualCluster

Deletes an EMR Containers virtual cluster as a Task.

EmrContainersStartJobRun

Starts a job run.

EmrCreateCluster

A Step Functions Task to create an EMR Cluster.

EmrModifyInstanceFleetByName

A Step Functions Task to to modify an InstanceFleet on an EMR Cluster.

EmrModifyInstanceGroupByName

A Step Functions Task to to modify an InstanceGroup on an EMR Cluster.

EmrSetClusterTerminationProtection

A Step Functions Task to to set Termination Protection on an EMR Cluster.

EmrTerminateCluster

A Step Functions Task to terminate an EMR Cluster.

EvaluateExpression

A Step Functions Task to evaluate an expression.

EventBridgePutEvents

A StepFunctions Task to send events to an EventBridge event bus.

GlueDataBrewStartJobRun

Start a Job run as a Task.

GlueStartCrawlerRun

Starts an AWS Glue Crawler in a Task state.

GlueStartJobRun

Starts an AWS Glue job in a Task state.

Guardrail

Guradrail settings for BedrockInvokeModel.

HttpInvoke

A Step Functions Task to call a public third-party API.

IContainerDefinition

Configuration of the container used to host the model.

IEcsLaunchTarget

An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.

ISageMakerTask

Task to train a machine learning model using Amazon SageMaker.

LambdaInvoke

Invoke a Lambda function as a Task.

MediaConvertCreateJob

A Step Functions Task to create a job in MediaConvert.

ReleaseLabel

The Amazon EMR release version to use for the job run.

S3Location

Constructs `IS3Location` objects.

SageMakerCreateEndpoint

A Step Functions Task to create a SageMaker endpoint.

SageMakerCreateEndpointConfig

A Step Functions Task to create a SageMaker endpoint configuration.

SageMakerCreateModel

A Step Functions Task to create a SageMaker model.

SageMakerCreateTrainingJob

Class representing the SageMaker Create Training Job task.

SageMakerCreateTransformJob

Class representing the SageMaker Create Transform Job task.

SageMakerUpdateEndpoint

A Step Functions Task to update a SageMaker endpoint.

SnsPublish

A Step Functions Task to publish messages to SNS topic.

SqsSendMessage

A StepFunctions Task to send messages to SQS queue.

StepFunctionsInvokeActivity

A Step Functions Task to invoke an Activity worker.

StepFunctionsStartExecution

A Step Functions Task to call StartExecution on another state machine.

VirtualClusterInput

Class that returns a virtual cluster's id depending on input type.

# Type aliases

ActionOnFailure

The action to take when the cluster step fails.

AssembleWith

How to assemble the results of the transform job as a single S3 object.

AuthType

The authentication method used to call the endpoint.

BatchStrategy

Specifies the number of records to include in a mini-batch for an HTTP inference request.

CompressionType

Compression type of the data.

DynamoConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned.

DynamoItemCollectionMetrics

Determines whether item collection metrics are returned.

DynamoReturnValues

Use ReturnValues if you want to get the item attributes as they appear before or after they are changed.

EmrCreateCluster_CloudWatchAlarmComparisonOperator

CloudWatch Alarm Comparison Operators.

EmrCreateCluster_CloudWatchAlarmStatistic

CloudWatch Alarm Statistics.

EmrCreateCluster_CloudWatchAlarmUnit

CloudWatch Alarm Units.

EmrCreateCluster_EbsBlockDeviceVolumeType

EBS Volume Types.

EmrCreateCluster_EmrClusterScaleDownBehavior

The Cluster ScaleDownBehavior specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.

EmrCreateCluster_InstanceMarket

EC2 Instance Market.

EmrCreateCluster_InstanceRoleType

Instance Role Types.

EmrCreateCluster_OnDemandAllocationStrategy

On-Demand Allocation Strategies.

EmrCreateCluster_ScalingAdjustmentType

AutoScaling Adjustment Type.

EmrCreateCluster_SpotAllocationStrategy

Spot Allocation Strategies.

EmrCreateCluster_SpotTimeoutAction

Spot Timeout Actions.