Package software.amazon.awscdk.services.stepfunctions.tasks

Class BedrockInvokeModel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.BedrockInvokeModel

All Implemented Interfaces:

IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-17T19:20:37.857Z")
@Stability(Stable)
public class BedrockInvokeModel
extends TaskStateBase

A Step Functions Task to invoke a model in Bedrock.

Example:

 import software.amazon.awscdk.services.bedrock.*;
 FoundationModel model = FoundationModel.fromFoundationModelId(this, "Model", FoundationModelIdentifier.AMAZON_TITAN_TEXT_G1_EXPRESS_V1);
 BedrockInvokeModel task = BedrockInvokeModel.Builder.create(this, "Prompt Model")
         .model(model)
         .body(TaskInput.fromObject(Map.of(
                 "inputText", "Generate a list of five first names.",
                 "textGenerationConfig", Map.of(
                         "maxTokenCount", 100,
                         "temperature", 1))))
         .resultSelector(Map.of(
                 "names", JsonPath.stringAt("$.Body.results[0].outputText")))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BedrockInvokeModel.Builder	A fluent builder for BedrockInvokeModel.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BedrockInvokeModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BedrockInvokeModel(software.amazon.jsii.JsiiObjectRef objRef)
	BedrockInvokeModel(software.constructs.Construct scope, String id, BedrockInvokeModelProps props)

Method Summary

Modifier and Type	Method	Description
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()
static BedrockInvokeModel	jsonata(software.constructs.Construct scope, String id, BedrockInvokeModelJsonataProps props)	A Step Functions Task using JSONata to invoke a model in Bedrock.
static BedrockInvokeModel	jsonPath(software.constructs.Construct scope, String id, BedrockInvokeModelJsonPathProps props)	A Step Functions Task using JSONPath to invoke a model in Bedrock.

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addChoice, addItemProcessor, addItemProcessor, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getArguments, getAssign, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getOutputs, getParameters, getProcessor, getProcessorConfig, getProcessorMode, getQueryLanguage, getResultPath, getResultSelector, getStartState, getStateId, getStateName, makeDefault, makeNext, prefixStates, renderAssign, renderAssign, renderBranches, renderChoices, renderChoices, renderInputOutput, renderItemProcessor, renderIterator, renderNextEnd, renderQueryLanguage, renderQueryLanguage, renderResultSelector, renderRetryCatch, renderRetryCatch, setDefaultChoice, setIteration, setProcessor, setProcessorConfig, setProcessorMode, validateState

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

BedrockInvokeModel

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

BedrockInvokeModel

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

BedrockInvokeModel

@Stability(Stable)
public BedrockInvokeModel(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BedrockInvokeModelProps props)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

props - This parameter is required.

Method Details

jsonata

@Stability(Stable)
@NotNull
public static BedrockInvokeModel jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BedrockInvokeModelJsonataProps props)

A Step Functions Task using JSONata to invoke a model in Bedrock.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

jsonPath

@Stability(Stable)
@NotNull
public static BedrockInvokeModel jsonPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BedrockInvokeModelJsonPathProps props)

A Step Functions Task using JSONPath to invoke a model in Bedrock.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

getTaskMetrics

@Stability(Stable)
@Nullable
protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

@Stability(Stable)
@Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase