Class BedrockInvokeModelProps.Jsii$Proxy
- All Implemented Interfaces:
AssignableStateOptions
,JsonataCommonOptions
,JsonPathCommonOptions
,StateBaseProps
,BedrockInvokeModelProps
,TaskStateBaseOptions
,TaskStateBaseProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
BedrockInvokeModelProps
BedrockInvokeModelProps
-
Nested Class Summary
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.tasks.BedrockInvokeModelProps
BedrockInvokeModelProps.Builder, BedrockInvokeModelProps.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theBedrockInvokeModelProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
The desired MIME type of the inference body in the response.Workflow variables to store in this step.final TaskInput
getBody()
The input data for the Bedrock model invocation.final String
A comment describing this state.final String
(deprecated) The MIME type of the input data in the request.final Credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.final Guardrail
The guardrail is applied to the invocation.final Duration
(deprecated) Timeout for the heartbeat.final Timeout
Timeout for the heartbeat.getInput()
The source location to retrieve the input data from.final String
JSONPath expression to select part of the state to be the input to this state.final IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.final IModel
getModel()
The Bedrock model that the task will invoke.The destination location where the API response is written.final String
JSONPath expression to select part of the state to be the output to this state.final Object
Used to specify and transform output from the state.final QueryLanguage
The name of the query language used by the state.final String
JSONPath expression to indicate where to inject the state's output.The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.final String
Optional name for this state.final Timeout
Timeout for the task.final Duration
(deprecated) Timeout for the task.final Boolean
Specifies whether to enable or disable the Bedrock trace.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theBedrockInvokeModelProps.Builder
.
-
-
Method Details
-
getModel
Description copied from interface:BedrockInvokeModelProps
The Bedrock model that the task will invoke.- Specified by:
getModel
in interfaceBedrockInvokeModelProps
- See Also:
-
getAccept
Description copied from interface:BedrockInvokeModelProps
The desired MIME type of the inference body in the response.Default: 'application/json'
- Specified by:
getAccept
in interfaceBedrockInvokeModelProps
- See Also:
-
getBody
Description copied from interface:BedrockInvokeModelProps
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 isapplication/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 theinput
field, but not both.Default: - Input data is retrieved from the location specified in the `input` field
- Specified by:
getBody
in interfaceBedrockInvokeModelProps
- See Also:
-
getContentType
Description copied from interface:BedrockInvokeModelProps
(deprecated) The MIME type of the input data in the request.Default: 'application/json'
- Specified by:
getContentType
in interfaceBedrockInvokeModelProps
- See Also:
-
getGuardrail
Description copied from interface:BedrockInvokeModelProps
The guardrail is applied to the invocation.Default: - No guardrail is applied to the invocation.
- Specified by:
getGuardrail
in interfaceBedrockInvokeModelProps
-
getInput
Description copied from interface:BedrockInvokeModelProps
The source location to retrieve the input data from.Default: - Input data is retrieved from the `body` field
- Specified by:
getInput
in interfaceBedrockInvokeModelProps
-
getOutput
Description copied from interface:BedrockInvokeModelProps
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.
Default: - The API response body is returned in the result.
- Specified by:
getOutput
in interfaceBedrockInvokeModelProps
-
getTraceEnabled
Description copied from interface:BedrockInvokeModelProps
Specifies whether to enable or disable the Bedrock trace.Default: - Trace is not enabled for the invocation.
- Specified by:
getTraceEnabled
in interfaceBedrockInvokeModelProps
-
getResultPath
Description copied from interface:TaskStateBaseProps
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.
Default: $
- Specified by:
getResultPath
in interfaceTaskStateBaseProps
-
getResultSelector
Description copied from interface:TaskStateBaseProps
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.
Default: - None
- Specified by:
getResultSelector
in interfaceTaskStateBaseProps
- See Also:
-
getComment
Description copied from interface:StateBaseProps
A comment describing this state.Default: No comment
- Specified by:
getComment
in interfaceStateBaseProps
-
getQueryLanguage
Description copied from interface:StateBaseProps
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-levelqueryLanguage
field.Default: - JSONPath
- Specified by:
getQueryLanguage
in interfaceStateBaseProps
-
getStateName
Description copied from interface:StateBaseProps
Optional name for this state.Default: - The construct ID will be used as state name
- Specified by:
getStateName
in interfaceStateBaseProps
-
getCredentials
Description copied from interface:TaskStateBaseOptions
Credentials for an IAM Role that the State Machine assumes for executing the task.This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
- Specified by:
getCredentials
in interfaceTaskStateBaseOptions
- See Also:
-
getHeartbeat
Description copied from interface:TaskStateBaseOptions
(deprecated) Timeout for the heartbeat.Default: - None
- Specified by:
getHeartbeat
in interfaceTaskStateBaseOptions
-
getHeartbeatTimeout
Description copied from interface:TaskStateBaseOptions
Timeout for the heartbeat.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Specified by:
getHeartbeatTimeout
in interfaceTaskStateBaseOptions
-
getIntegrationPattern
Description copied from interface:TaskStateBaseOptions
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.
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
- Specified by:
getIntegrationPattern
in interfaceTaskStateBaseOptions
- See Also:
-
getTaskTimeout
Description copied from interface:TaskStateBaseOptions
Timeout for the task.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Specified by:
getTaskTimeout
in interfaceTaskStateBaseOptions
-
getTimeout
Description copied from interface:TaskStateBaseOptions
(deprecated) Timeout for the task.Default: - None
- Specified by:
getTimeout
in interfaceTaskStateBaseOptions
-
getAssign
Description copied from interface:AssignableStateOptions
Workflow variables to store in this step.Using workflow variables, you can store data in a step and retrieve that data in future steps.
Default: - Not assign variables
- Specified by:
getAssign
in interfaceAssignableStateOptions
- See Also:
-
getInputPath
Description copied from interface:JsonPathCommonOptions
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 {}.
Default: $
- Specified by:
getInputPath
in interfaceJsonPathCommonOptions
-
getOutputPath
Description copied from interface:JsonPathCommonOptions
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 {}.
Default: $
- Specified by:
getOutputPath
in interfaceJsonPathCommonOptions
-
getOutputs
Description copied from interface:JsonataCommonOptions
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.
Default: - $states.result or $states.errorOutput
- Specified by:
getOutputs
in interfaceJsonataCommonOptions
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-