2.178.2

interface BedrockInvokeModelProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.BedrockInvokeModelProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#BedrockInvokeModelProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.BedrockInvokeModelProps
Pythonaws_cdk.aws_stepfunctions_tasks.BedrockInvokeModelProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions_tasks » BedrockInvokeModelProps

Properties for invoking a Bedrock Model.

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'),
  },
});

Properties

NameTypeDescription
modelIModelThe Bedrock model that the task will invoke.
accept?stringThe desired MIME type of the inference body in the response.
assign?{ [string]: any }Workflow variables to store in this step.
body?TaskInputThe input data for the Bedrock model invocation.
comment?stringA comment describing this state.
contentType?⚠️stringThe MIME type of the input data in the request.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
guardrail?GuardrailThe guardrail is applied to the invocation.
heartbeat?⚠️DurationTimeout for the heartbeat.
heartbeatTimeout?TimeoutTimeout for the heartbeat.
input?BedrockInvokeModelInputPropsThe source location to retrieve the input data from.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
output?BedrockInvokeModelOutputPropsThe destination location where the API response is written.
outputPath?stringJSONPath expression to select part of the state to be the output to this state.
outputs?anyUsed to specify and transform output from the state.
queryLanguage?QueryLanguageThe name of the query language used by the state.
resultPath?stringJSONPath expression to indicate where to inject the state's output.
resultSelector?{ [string]: any }The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
stateName?stringOptional name for this state.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.
traceEnabled?booleanSpecifies whether to enable or disable the Bedrock trace.

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

assign?

Type: { [string]: any } (optional, default: Not assign variables)

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

See also: https://docs.aws.amazon.com/ja_jp/step-functions/latest/dg/workflow-variables.html

body?

Type: TaskInput (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)

A comment describing this state.

contentType?⚠️

⚠️ Deprecated: This property does not require configuration because the only acceptable value is 'application/json'.

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

guardrail?

Type: Guardrail (optional, default: No guardrail is applied to the invocation.)

The guardrail is applied to the invocation.

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: BedrockInvokeModelInputProps (optional, default: Input data is retrieved from the body field)

The source location to retrieve the input data from.

inputPath?

Type: string (optional, default: $)

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: IntegrationPattern (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: BedrockInvokeModelOutputProps (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: $)

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

outputs?

Type: any (optional, default: $states.result or $states.errorOutput)

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

queryLanguage?

Type: QueryLanguage (optional, default: JSONPath)

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

resultPath?

Type: string (optional, default: $)

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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

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.

traceEnabled?

Type: boolean (optional, default: Trace is not enabled for the invocation.)

Specifies whether to enable or disable the Bedrock trace.

← PreviousNext →