aws-cdk-lib.aws_stepfunctions.FieldUtils

class FieldUtils

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.FieldUtils
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#FieldUtils
Javasoftware.amazon.awscdk.services.stepfunctions.FieldUtils
Pythonaws_cdk.aws_stepfunctions.FieldUtils
TypeScript (source)aws-cdk-lib » aws_stepfunctions » FieldUtils

Helper functions to work with structures containing fields.

Methods

NameDescription
static containsTaskToken(obj?)Returns whether the given task structure contains the TaskToken field anywhere.
static findReferencedPaths(obj?)Return all JSON paths used in the given structure.
static renderObject(obj?)Render a JSON structure containing fields to the right StepFunctions structure.

static containsTaskToken(obj?)

public static containsTaskToken(obj?: { [string]: any }): boolean

Parameters

  • obj { [string]: any }

Returns

  • boolean

Returns whether the given task structure contains the TaskToken field anywhere.

The field is considered included if the field itself or one of its containing fields occurs anywhere in the payload.


static findReferencedPaths(obj?)

public static findReferencedPaths(obj?: { [string]: any }): string[]

Parameters

  • obj { [string]: any }

Returns

  • string[]

Return all JSON paths used in the given structure.


static renderObject(obj?)

public static renderObject(obj?: { [string]: any }): { [string]: any }

Parameters

  • obj { [string]: any }

Returns

  • { [string]: any }

Render a JSON structure containing fields to the right StepFunctions structure.