class BedrockInvokeModel (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.Tasks.BedrockInvokeModel |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#BedrockInvokeModel |
Java | software.amazon.awscdk.services.stepfunctions.tasks.BedrockInvokeModel |
Python | aws_cdk.aws_stepfunctions_tasks.BedrockInvokeModel |
TypeScript (source) | aws-cdk-lib » aws_stepfunctions_tasks » BedrockInvokeModel |
Implements
IConstruct
, IDependable
, IChainable
, INextable
A Step Functions Task to invoke a model in Bedrock.
Example
import * as bedrock from 'aws-cdk-lib/aws-bedrock';
const model = bedrock.FoundationModel.fromFoundationModelId(
this,
'Model',
bedrock.FoundationModelIdentifier.AMAZON_TITAN_TEXT_G1_EXPRESS_V1,
);
const task = new tasks.BedrockInvokeModel(this, 'Prompt Model', {
model,
body: sfn.TaskInput.fromObject(
{
inputText: 'Generate a list of five first names.',
textGenerationConfig: {
maxTokenCount: 100,
temperature: 1,
},
},
),
resultSelector: {
names: sfn.JsonPath.stringAt('$.Body.results[0].outputText'),
},
});
Initializer
new BedrockInvokeModel(scope: Construct, id: string, props: BedrockInvokeModelProps)
Parameters
- scope
Construct
- id
string
— Descriptive identifier for this chainable. - props
Bedrock
Invoke Model Props
Construct Props
Name | Type | Description |
---|---|---|
model | IModel | The Bedrock model that the task will invoke. |
accept? | string | The desired MIME type of the inference body in the response. |
body? | Task | The input data for the Bedrock model invocation. |
comment? | string | An optional description for this state. |
content | string | The MIME type of the input data in the request. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input? | Bedrock | The source location to retrieve the input data from. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
output? | Bedrock | The destination location where the API response is written. |
output | string | JSONPath expression to select select a portion of the state output to pass to the next state. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
state | string | Optional name for this state. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
model
Type:
IModel
The Bedrock model that the task will invoke.
See also: https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html
accept?
Type:
string
(optional, default: 'application/json')
The desired MIME type of the inference body in the response.
See also: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html
body?
Type:
Task
(optional, default: Input data is retrieved from the location specified in the input
field)
The input data for the Bedrock model invocation.
The inference parameters contained in the body depend on the Bedrock model being used.
The body must be in the format specified in the contentType
field.
For example, if the content type is application/json
, the body must be
JSON formatted.
The body must be up to 256 KB in size. For input data that exceeds 256 KB,
use input
instead to retrieve the input data from S3.
You must specify either the body
or the input
field, but not both.
See also: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html
comment?
Type:
string
(optional, default: No comment)
An optional description for this state.
contentType?
Type:
string
(optional, default: 'application/json')
The MIME type of the input data in the request.
See also: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html
credentials?
Type:
Credentials
(optional, default: None (Task is executed using the State Machine's execution role))
Credentials for an IAM Role that the State Machine assumes for executing the task.
This enables cross-account resource invocations.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
heartbeat?
⚠️ Deprecated: use heartbeatTimeout
Type:
Duration
(optional, default: None)
Timeout for the heartbeat.
heartbeatTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
input?
Type:
Bedrock
(optional, default: Input data is retrieved from the body
field)
The source location to retrieve the input data from.
inputPath?
Type:
string
(optional, default: The entire task input (JSON path '$'))
JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPattern?
Type:
Integration
(optional, default: IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.)
AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
output?
Type:
Bedrock
(optional, default: The API response body is returned in the result.)
The destination location where the API response is written.
If you specify this field, the API response body is replaced with a reference to the output location.
outputPath?
Type:
string
(optional, default: The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path '$'))
JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
resultPath?
Type:
string
(optional, default: Replaces the entire input with the result (JSON path '$'))
JSONPath expression to indicate where to inject the state's output.
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelector?
Type:
{ [string]: any }
(optional, default: None)
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.
taskTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeout?
⚠️ Deprecated: use taskTimeout
Type:
Duration
(optional, default: None)
Timeout for the task.
Properties
Name | Type | Description |
---|---|---|
end | INextable [] | Continuable states of this Chainable. |
id | string | Descriptive identifier for this chainable. |
node | Node | The tree node. |
start | State | First state of this Chainable. |
state | string | Tokenized string that evaluates to the state's ID. |
task | Task | |
task | Policy [] |
endStates
Type:
INextable
[]
Continuable states of this Chainable.
id
Type:
string
Descriptive identifier for this chainable.
node
Type:
Node
The tree node.
startState
Type:
State
First state of this Chainable.
stateId
Type:
string
Tokenized string that evaluates to the state's ID.
taskMetrics?
Type:
Task
(optional)
taskPolicies?
Type:
Policy
[]
(optional)
Methods
Name | Description |
---|---|
add | Add a recovery handler for this state. |
add | Add a prefix to the stateId of this state. |
add | Add retry configuration for this state. |
bind | Register this state as part of the given graph. |
metric(metricName, props?) | Return the given named metric for this Task. |
metric | Metric for the number of times this activity fails. |
metric | Metric for the number of times the heartbeat times out for this activity. |
metric | The interval, in milliseconds, between the time the Task starts and the time it closes. |
metric | The interval, in milliseconds, for which the activity stays in the schedule state. |
metric | Metric for the number of times this activity is scheduled. |
metric | Metric for the number of times this activity is started. |
metric | Metric for the number of times this activity succeeds. |
metric | The interval, in milliseconds, between the time the activity is scheduled and the time it closes. |
metric | Metric for the number of times this activity times out. |
next(next) | Continue normal execution with the given state. |
to | Return the Amazon States Language object for this state. |
to | Returns a string representation of this construct. |
Catch(handler, props?)
addpublic addCatch(handler: IChainable, props?: CatchProps): TaskStateBase
Parameters
- handler
IChainable
- props
Catch
Props
Returns
Add a recovery handler for this state.
When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.
Prefix(x)
addpublic addPrefix(x: string): void
Parameters
- x
string
Add a prefix to the stateId of this state.
Retry(props?)
addpublic addRetry(props?: RetryProps): TaskStateBase
Parameters
- props
Retry
Props
Returns
Add retry configuration for this state.
This controls if and how the execution will be retried if a particular error occurs.
ToGraph(graph)
bindpublic bindToGraph(graph: StateGraph): void
Parameters
- graph
State
Graph
Register this state as part of the given graph.
Don't call this. It will be called automatically when you work with states normally.
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Return the given named metric for this Task.
Failed(props?)
metricpublic metricFailed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity fails.
HeartbeatTimedOut(props?)
metricpublic metricHeartbeatTimedOut(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times the heartbeat times out for this activity.
RunTime(props?)
metricpublic metricRunTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, between the time the Task starts and the time it closes.
ScheduleTime(props?)
metricpublic metricScheduleTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, for which the activity stays in the schedule state.
Scheduled(props?)
metricpublic metricScheduled(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity is scheduled.
Started(props?)
metricpublic metricStarted(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity is started.
Succeeded(props?)
metricpublic metricSucceeded(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity succeeds.
Time(props?)
metricpublic metricTime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
TimedOut(props?)
metricpublic metricTimedOut(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of times this activity times out.
next(next)
public next(next: IChainable): Chain
Parameters
- next
IChainable
Returns
Continue normal execution with the given state.
StateJson()
topublic toStateJson(): json
Returns
json
Return the Amazon States Language object for this state.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.