BedrockInvokeModelJsonataProps Struct
Properties for invoking a Bedrock Model.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';
declare const assign: any;
declare const guardrail: stepfunctions_tasks.Guardrail;
declare const model: bedrock.IModel;
declare const outputs: any;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const bedrockInvokeModelJsonataProps: stepfunctions_tasks.BedrockInvokeModelJsonataProps = {
model: model,
// the properties below are optional
accept: 'accept',
assign: {
assignKey: assign,
},
body: taskInput,
comment: 'comment',
contentType: 'contentType',
credentials: {
role: taskRole,
},
guardrail: guardrail,
heartbeat: cdk.Duration.minutes(30),
heartbeatTimeout: timeout,
input: {
s3InputUri: 's3InputUri',
s3Location: {
bucketName: 'bucketName',
objectKey: 'objectKey',
// the properties below are optional
objectVersion: 'objectVersion',
},
},
integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
output: {
s3Location: {
bucketName: 'bucketName',
objectKey: 'objectKey',
// the properties below are optional
objectVersion: 'objectVersion',
},
s3OutputUri: 's3OutputUri',
},
outputs: outputs,
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
stateName: 'stateName',
taskTimeout: timeout,
timeout: cdk.Duration.minutes(30),
traceEnabled: false,
};
Properties
acceptoptionalstringacceptoptionalstracceptoptionalStringAcceptoptionalstringAcceptoptional*string= 'application/json'#assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
bodyoptionalTaskInputbodyoptionalTaskInputbodyoptionalTaskInputBodyoptionalTaskInputBodyoptionalTaskInput#Default: Input data is retrieved from the location specified in the input field
notes
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.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#Default: No comment
contentTypeoptionalstringcontent_typeoptionalstrcontentTypeoptionalStringContentTypeoptionalstringContentTypeoptional*string= 'application/json'deprecated#credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#Default: None (Task is executed using the State Machine's execution role)
This enables cross-account resource invocations.
guardrailoptionalGuardrailguardrailoptionalGuardrailguardrailoptionalGuardrailGuardrailoptionalGuardrailGuardrailoptionalGuardrail#Default: No guardrail is applied to the invocation.
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout= None#[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputoptionalBedrockInvokeModelInputPropsinputoptionalBedrockInvokeModelInputPropsinputoptionalBedrockInvokeModelInputPropsInputoptionalBedrockInvokeModelInputPropsInputoptionalBedrockInvokeModelInputProps#Default: Input data is retrieved from the body field
integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern#Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
outputoptionalBedrockInvokeModelOutputPropsoutputoptionalBedrockInvokeModelOutputPropsoutputoptionalBedrockInvokeModelOutputPropsOutputoptionalBedrockInvokeModelOutputPropsOutputoptionalBedrockInvokeModelOutputProps#Default: The API response body is returned in the result.
If you specify this field, the API response body is replaced with a reference to the output location.
outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{}#Default: $states.result or $states.errorOutput
notes
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.
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSONPath#If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#Default: The construct ID will be used as state name
taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout= None#[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Nonedeprecated#traceEnabledoptionalbooleantrace_enabledoptionalbooltraceEnabledoptionalBooleanTraceEnabledoptionalboolTraceEnabledoptional*bool#Default: Trace is not enabled for the invocation.