software.amazon.awscdk.services.stepfunctions

Class JsonPath

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.JsonPath

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:15.464Z")
 @Stability(value=Experimental)
public class JsonPath
extends software.amazon.jsii.JsiiObject

(experimental) Extract a field from the State Machine data or context that gets passed around between states.

Example:

 Function fn;
 LambdaInvoke.Builder.create(this, "Invoke Handler")
         .lambdaFunction(fn)
         .resultSelector(Map.of(
                 "lambdaOutput", JsonPath.stringAt("$.Payload"),
                 "invokeRequestId", JsonPath.stringAt("$.SdkResponseMetadata.RequestId"),
                 "staticValue", Map.of(
                         "foo", "bar"),
                 "stateName", JsonPath.stringAt("$.State.Name")))
         .build();
 

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-paths.html

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISCARD (experimental) Special string value to discard state input, output or result.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonPath(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	JsonPath(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static String	getEntireContext() (experimental) Use the entire context data structure.
static String	getEntirePayload() (experimental) Use the entire data structure.
static String	getTaskToken() (experimental) Return the Task Token field.
static Boolean	isEncodedJsonPath(String value) (experimental) Determines if the indicated string is an encoded JSON path.
static List<String>	listAt(String path) (experimental) Instead of using a literal string list, get the value from a JSON path.
static Number	numberAt(String path) (experimental) Instead of using a literal number, get the value from a JSON path.
static String	stringAt(String path) (experimental) Instead of using a literal string, get the value from a JSON path.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

DISCARD

@Stability(value=Experimental)
public static final String DISCARD

(experimental) Special string value to discard state input, output or result.

Constructor Detail

JsonPath

protected JsonPath(software.amazon.jsii.JsiiObjectRef objRef)

JsonPath

protected JsonPath(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

isEncodedJsonPath

@Stability(value=Experimental)
 @NotNull
public static Boolean isEncodedJsonPath(@NotNull
                                                                                 String value)

(experimental) Determines if the indicated string is an encoded JSON path.

Parameters:

value - string to be evaluated. This parameter is required.

listAt

@Stability(value=Experimental)
 @NotNull
public static List<String> listAt(@NotNull
                                                                           String path)

(experimental) Instead of using a literal string list, get the value from a JSON path.

Parameters:

path - This parameter is required.

numberAt

@Stability(value=Experimental)
 @NotNull
public static Number numberAt(@NotNull
                                                                       String path)

(experimental) Instead of using a literal number, get the value from a JSON path.

Parameters:

path - This parameter is required.

stringAt

@Stability(value=Experimental)
 @NotNull
public static String stringAt(@NotNull
                                                                       String path)

(experimental) Instead of using a literal string, get the value from a JSON path.

Parameters:

path - This parameter is required.

getEntireContext

@Stability(value=Experimental)
 @NotNull
public static String getEntireContext()

(experimental) Use the entire context data structure.

Will be an object at invocation time, but is represented in the CDK application as a string.

getEntirePayload

@Stability(value=Experimental)
 @NotNull
public static String getEntirePayload()

(experimental) Use the entire data structure.

Will be an object at invocation time, but is represented in the CDK application as a string.

getTaskToken

@Stability(value=Experimental)
 @NotNull
public static String getTaskToken()

(experimental) Return the Task Token field.

External actions will need this token to report step completion back to StepFunctions using the SendTaskSuccess or SendTaskFailure calls.