Skip to content

Bedrock Runtime Classes

ApplyGuardrailRequest

guardrailIdentifier

  • Type:
  • Required: Yes

guardrailVersion

  • Type:
  • Required: Yes

source

  • Type: typing.Literal['INPUT', 'OUTPUT']
  • Required: Yes

content

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailContentBlock]
  • Required: Yes

ApplyGuardrailResponse

usage

  • Type:
  • Required: Yes

action

  • Type: typing.Literal['GUARDRAIL_INTERVENED', 'NONE']
  • Required: Yes

outputs

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailOutputContent]
  • Required: Yes

assessments

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailAssessment]
  • Required: Yes

guardrailCoverage

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

AsyncInvokeOutputDataConfig

s3OutputDataConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.AsyncInvokeS3OutputDataConfig]

AsyncInvokeS3OutputDataConfig

s3Uri

  • Type:
  • Required: Yes

kmsKeyId

  • Type: typing.Optional[str]

bucketOwner

  • Type: typing.Optional[str]

AsyncInvokeSummary

invocationArn

  • Type:
  • Required: Yes

modelArn

  • Type:
  • Required: Yes

submitTime

  • Type:
  • Required: Yes

outputDataConfig

  • Type:
  • Required: Yes

clientRequestToken

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['Completed', 'Failed', 'InProgress']]

failureMessage

  • Type: typing.Optional[str]

lastModifiedTime

  • Type: typing.Optional[datetime.datetime]

endTime

  • Type: typing.Optional[datetime.datetime]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

ContentBlock

text

  • Type: typing.Optional[str]

image

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ImageBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ImageBlockOutput, NoneType]

document

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.DocumentBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.DocumentBlockOutput, NoneType]

video

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.VideoBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.VideoBlockOutput, NoneType]

toolUse

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolUseBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolUseBlockOutput, NoneType]

toolResult

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolResultBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolResultBlockOutput, NoneType]

guardContent

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseContentBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseContentBlockOutput, NoneType]

reasoningContent

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ReasoningContentBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ReasoningContentBlockOutput, NoneType]

ContentBlockDelta

text

  • Type: typing.Optional[str]

toolUse

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolUseBlockDelta]

reasoningContent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ReasoningContentBlockDelta]

ContentBlockDeltaEvent

delta

  • Type:
  • Required: Yes

contentBlockIndex

  • Type:
  • Required: Yes

ContentBlockOutput

text

  • Type: typing.Optional[str]

image

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ImageBlockOutput]

document

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.DocumentBlockOutput]

video

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.VideoBlockOutput]

toolUse

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolUseBlockOutput]

toolResult

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolResultBlockOutput]

guardContent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseContentBlockOutput]

reasoningContent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ReasoningContentBlockOutput]

ContentBlockStart

toolUse

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolUseBlockStart]

ContentBlockStartEvent

start

  • Type:
  • Required: Yes

contentBlockIndex

  • Type:
  • Required: Yes

ContentBlockStopEvent

contentBlockIndex

  • Type:
  • Required: Yes

ConverseMetrics

latencyMs

  • Type:
  • Required: Yes

ConverseOutput

message

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.MessageOutput]

ConverseRequest

modelId

  • Type:
  • Required: Yes

messages

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.Message, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.MessageOutput]]]

system

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.SystemContentBlock]]

inferenceConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.InferenceConfiguration]

toolConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolConfiguration]

guardrailConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConfiguration]

additionalModelRequestFields

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

promptVariables

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.PromptVariableValues]]

additionalModelResponseFieldPaths

  • Type: typing.Optional[typing.List[str]]

requestMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

performanceConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.PerformanceConfiguration]

ConverseResponse

output

  • Type:
  • Required: Yes

stopReason

  • Type: typing.Literal['content_filtered', 'end_turn', 'guardrail_intervened', 'max_tokens', 'stop_sequence', 'tool_use']
  • Required: Yes

usage

  • Type:
  • Required: Yes

metrics

  • Type:
  • Required: Yes

additionalModelResponseFields

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

trace

  • Type:
  • Required: Yes

performanceConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ConverseStreamMetadataEvent

usage

  • Type:
  • Required: Yes

metrics

  • Type:
  • Required: Yes

trace

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ConverseStreamTrace]

performanceConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.PerformanceConfiguration]

ConverseStreamMetrics

latencyMs

  • Type:
  • Required: Yes

ConverseStreamOutput

messageStart

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.MessageStartEvent]

contentBlockStart

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ContentBlockStartEvent]

contentBlockDelta

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ContentBlockDeltaEvent]

contentBlockStop

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ContentBlockStopEvent]

messageStop

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.MessageStopEvent]

metadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ConverseStreamMetadataEvent]

internalServerException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.InternalServerException]

modelStreamErrorException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ModelStreamErrorException]

validationException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ValidationException]

throttlingException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ThrottlingException]

serviceUnavailableException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ServiceUnavailableException]

ConverseStreamRequest

modelId

  • Type:
  • Required: Yes

messages

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.Message, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.MessageOutput]]]

system

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.SystemContentBlock]]

inferenceConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.InferenceConfiguration]

toolConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolConfiguration]

guardrailConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailStreamConfiguration]

additionalModelRequestFields

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

promptVariables

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.PromptVariableValues]]

additionalModelResponseFieldPaths

  • Type: typing.Optional[typing.List[str]]

requestMetadata

  • Type: typing.Optional[typing.Dict[str, str]]

performanceConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.PerformanceConfiguration]

ConverseStreamResponse

stream

  • Type: aws_resource_validator.pydantic_models.base_validator_model.EventStream[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ConverseStreamOutput]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ConverseStreamTrace

guardrail

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailTraceAssessment]

promptRouter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.PromptRouterTrace]

ConverseTrace

guardrail

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailTraceAssessment]

promptRouter

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.PromptRouterTrace]

DocumentBlock

format

  • Type: typing.Literal['csv', 'doc', 'docx', 'html', 'md', 'pdf', 'txt', 'xls', 'xlsx']
  • Required: Yes

name

  • Type:
  • Required: Yes

source

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.DocumentSource, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.DocumentSourceOutput]
  • Required: Yes

DocumentBlockOutput

format

  • Type: typing.Literal['csv', 'doc', 'docx', 'html', 'md', 'pdf', 'txt', 'xls', 'xlsx']
  • Required: Yes

name

  • Type:
  • Required: Yes

source

  • Type:
  • Required: Yes

DocumentSource

bytes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

DocumentSourceOutput

bytes

  • Type:

GetAsyncInvokeRequest

invocationArn

  • Type:
  • Required: Yes

GetAsyncInvokeResponse

invocationArn

  • Type:
  • Required: Yes

modelArn

  • Type:
  • Required: Yes

clientRequestToken

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['Completed', 'Failed', 'InProgress']
  • Required: Yes

failureMessage

  • Type:
  • Required: Yes

submitTime

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

endTime

  • Type:
  • Required: Yes

outputDataConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GuardrailAssessment

topicPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailTopicPolicyAssessment]

contentPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailContentPolicyAssessment]

wordPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailWordPolicyAssessment]

sensitiveInformationPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailSensitiveInformationPolicyAssessment]

contextualGroundingPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailContextualGroundingPolicyAssessment]

invocationMetrics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailInvocationMetrics]

GuardrailConfiguration

guardrailIdentifier

  • Type:
  • Required: Yes

guardrailVersion

  • Type:
  • Required: Yes

trace

  • Type: typing.Optional[typing.Literal['disabled', 'enabled']]

GuardrailContentBlock

text

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailTextBlock]

image

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailImageBlock]

GuardrailContentFilter

type

  • Type: typing.Literal['HATE', 'INSULTS', 'MISCONDUCT', 'PROMPT_ATTACK', 'SEXUAL', 'VIOLENCE']
  • Required: Yes

confidence

  • Type: typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NONE']
  • Required: Yes

action

  • Type: typing.Literal['BLOCKED']
  • Required: Yes

filterStrength

  • Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NONE']]

GuardrailContentPolicyAssessment

filters

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailContentFilter]
  • Required: Yes

GuardrailContextualGroundingFilter

type

  • Type: typing.Literal['GROUNDING', 'RELEVANCE']
  • Required: Yes

threshold

  • Type:
  • Required: Yes

score

  • Type:
  • Required: Yes

action

  • Type: typing.Literal['BLOCKED', 'NONE']
  • Required: Yes

GuardrailContextualGroundingPolicyAssessment

filters

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailContextualGroundingFilter]]

GuardrailConverseContentBlock

text

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseTextBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseTextBlockOutput, NoneType]

image

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseImageBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseImageBlockOutput, NoneType]

GuardrailConverseContentBlockOutput

text

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseTextBlockOutput]

image

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseImageBlockOutput]

GuardrailConverseImageBlock

format

  • Type: typing.Literal['jpeg', 'png']
  • Required: Yes

source

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseImageSource, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseImageSourceOutput]
  • Required: Yes

GuardrailConverseImageBlockOutput

format

  • Type: typing.Literal['jpeg', 'png']
  • Required: Yes

source

  • Type:
  • Required: Yes

GuardrailConverseImageSource

bytes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

GuardrailConverseImageSourceOutput

bytes

  • Type:

GuardrailConverseTextBlock

text

  • Type:
  • Required: Yes

qualifiers

  • Type: typing.Optional[typing.List[typing.Literal['grounding_source', 'guard_content', 'query']]]

GuardrailConverseTextBlockOutput

text

  • Type:
  • Required: Yes

qualifiers

  • Type: typing.Optional[typing.List[typing.Literal['grounding_source', 'guard_content', 'query']]]

GuardrailCoverage

textCharacters

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailTextCharactersCoverage]

images

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailImageCoverage]

GuardrailCustomWord

match

  • Type:
  • Required: Yes

action

  • Type: typing.Literal['BLOCKED']
  • Required: Yes

GuardrailImageBlock

format

  • Type: typing.Literal['jpeg', 'png']
  • Required: Yes

source

  • Type:
  • Required: Yes

GuardrailImageCoverage

guarded

  • Type: typing.Optional[int]

total

  • Type: typing.Optional[int]

GuardrailImageSource

bytes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

GuardrailInvocationMetrics

guardrailProcessingLatency

  • Type: typing.Optional[int]

usage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailUsage]

guardrailCoverage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailCoverage]

GuardrailManagedWord

match

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['PROFANITY']
  • Required: Yes

action

  • Type: typing.Literal['BLOCKED']
  • Required: Yes

GuardrailOutputContent

text

  • Type: typing.Optional[str]

GuardrailPiiEntityFilter

match

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['ADDRESS', 'AGE', 'AWS_ACCESS_KEY', 'AWS_SECRET_KEY', 'CA_HEALTH_NUMBER', 'CA_SOCIAL_INSURANCE_NUMBER', 'CREDIT_DEBIT_CARD_CVV', 'CREDIT_DEBIT_CARD_EXPIRY', 'CREDIT_DEBIT_CARD_NUMBER', 'DRIVER_ID', 'EMAIL', 'INTERNATIONAL_BANK_ACCOUNT_NUMBER', 'IP_ADDRESS', 'LICENSE_PLATE', 'MAC_ADDRESS', 'NAME', 'PASSWORD', 'PHONE', 'PIN', 'SWIFT_CODE', 'UK_NATIONAL_HEALTH_SERVICE_NUMBER', 'UK_NATIONAL_INSURANCE_NUMBER', 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER', 'URL', 'USERNAME', 'US_BANK_ACCOUNT_NUMBER', 'US_BANK_ROUTING_NUMBER', 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER', 'US_PASSPORT_NUMBER', 'US_SOCIAL_SECURITY_NUMBER', 'VEHICLE_IDENTIFICATION_NUMBER']
  • Required: Yes

action

  • Type: typing.Literal['ANONYMIZED', 'BLOCKED']
  • Required: Yes

GuardrailRegexFilter

action

  • Type: typing.Literal['ANONYMIZED', 'BLOCKED']
  • Required: Yes

name

  • Type: typing.Optional[str]

match

  • Type: typing.Optional[str]

regex

  • Type: typing.Optional[str]

GuardrailSensitiveInformationPolicyAssessment

piiEntities

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailPiiEntityFilter]
  • Required: Yes

regexes

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailRegexFilter]
  • Required: Yes

GuardrailStreamConfiguration

guardrailIdentifier

  • Type:
  • Required: Yes

guardrailVersion

  • Type:
  • Required: Yes

trace

  • Type: typing.Optional[typing.Literal['disabled', 'enabled']]

streamProcessingMode

  • Type: typing.Optional[typing.Literal['async', 'sync']]

GuardrailTextBlock

text

  • Type:
  • Required: Yes

qualifiers

  • Type: typing.Optional[typing.List[typing.Literal['grounding_source', 'guard_content', 'query']]]

GuardrailTextCharactersCoverage

guarded

  • Type: typing.Optional[int]

total

  • Type: typing.Optional[int]

GuardrailTopic

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['DENY']
  • Required: Yes

action

  • Type: typing.Literal['BLOCKED']
  • Required: Yes

GuardrailTopicPolicyAssessment

topics

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailTopic]
  • Required: Yes

GuardrailTraceAssessment

modelOutput

  • Type: typing.Optional[typing.List[str]]

inputAssessment

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailAssessment]]

outputAssessments

  • Type: typing.Optional[typing.Dict[str, typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailAssessment]]]

GuardrailUsage

topicPolicyUnits

  • Type:
  • Required: Yes

contentPolicyUnits

  • Type:
  • Required: Yes

wordPolicyUnits

  • Type:
  • Required: Yes

sensitiveInformationPolicyUnits

  • Type:
  • Required: Yes

sensitiveInformationPolicyFreeUnits

  • Type:
  • Required: Yes

contextualGroundingPolicyUnits

  • Type:
  • Required: Yes

GuardrailWordPolicyAssessment

customWords

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailCustomWord]
  • Required: Yes

managedWordLists

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailManagedWord]
  • Required: Yes

ImageBlock

format

  • Type: typing.Literal['gif', 'jpeg', 'png', 'webp']
  • Required: Yes

source

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ImageSource, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ImageSourceOutput]
  • Required: Yes

ImageBlockOutput

format

  • Type: typing.Literal['gif', 'jpeg', 'png', 'webp']
  • Required: Yes

source

  • Type:
  • Required: Yes

ImageSource

bytes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

ImageSourceOutput

bytes

  • Type:

InferenceConfiguration

maxTokens

  • Type: typing.Optional[int]

temperature

  • Type: typing.Optional[float]

topP

  • Type: typing.Optional[float]

stopSequences

  • Type: typing.Optional[typing.List[str]]

InternalServerException

message

  • Type: typing.Optional[str]

InvokeModelRequest

modelId

  • Type:
  • Required: Yes

body

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

contentType

  • Type: typing.Optional[str]

accept

  • Type: typing.Optional[str]

trace

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

guardrailIdentifier

  • Type: typing.Optional[str]

guardrailVersion

  • Type: typing.Optional[str]

performanceConfigLatency

  • Type: typing.Optional[typing.Literal['optimized', 'standard']]

InvokeModelResponse

body

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

performanceConfigLatency

  • Type: typing.Literal['optimized', 'standard']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

InvokeModelWithResponseStreamRequest

modelId

  • Type:
  • Required: Yes

body

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

contentType

  • Type: typing.Optional[str]

accept

  • Type: typing.Optional[str]

trace

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

guardrailIdentifier

  • Type: typing.Optional[str]

guardrailVersion

  • Type: typing.Optional[str]

performanceConfigLatency

  • Type: typing.Optional[typing.Literal['optimized', 'standard']]

InvokeModelWithResponseStreamResponse

body

  • Type: aws_resource_validator.pydantic_models.base_validator_model.EventStream[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ResponseStream]
  • Required: Yes

contentType

  • Type:
  • Required: Yes

performanceConfigLatency

  • Type: typing.Literal['optimized', 'standard']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListAsyncInvokesRequest

submitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

submitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

statusEquals

  • Type: typing.Optional[typing.Literal['Completed', 'Failed', 'InProgress']]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

sortBy

  • Type: typing.Optional[typing.Literal['SubmissionTime']]

sortOrder

  • Type: typing.Optional[typing.Literal['Ascending', 'Descending']]

ListAsyncInvokesRequestPaginate

submitTimeAfter

  • Type: typing.Union[datetime.datetime, str, NoneType]

submitTimeBefore

  • Type: typing.Union[datetime.datetime, str, NoneType]

statusEquals

  • Type: typing.Optional[typing.Literal['Completed', 'Failed', 'InProgress']]

sortBy

  • Type: typing.Optional[typing.Literal['SubmissionTime']]

sortOrder

  • Type: typing.Optional[typing.Literal['Ascending', 'Descending']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.PaginatorConfig]

ListAsyncInvokesResponse

asyncInvokeSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.AsyncInvokeSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

Message

role

  • Type: typing.Literal['assistant', 'user']
  • Required: Yes

content

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ContentBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ContentBlockOutput]]
  • Required: Yes

MessageOutput

role

  • Type: typing.Literal['assistant', 'user']
  • Required: Yes

content

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ContentBlockOutput]
  • Required: Yes

MessageStartEvent

role

  • Type: typing.Literal['assistant', 'user']
  • Required: Yes

MessageStopEvent

stopReason

  • Type: typing.Literal['content_filtered', 'end_turn', 'guardrail_intervened', 'max_tokens', 'stop_sequence', 'tool_use']
  • Required: Yes

additionalModelResponseFields

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

ModelStreamErrorException

message

  • Type: typing.Optional[str]

originalStatusCode

  • Type: typing.Optional[int]

originalMessage

  • Type: typing.Optional[str]

ModelTimeoutException

message

  • Type: typing.Optional[str]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PayloadPart

bytes

  • Type:

PerformanceConfiguration

latency

  • Type: typing.Optional[typing.Literal['optimized', 'standard']]

PromptRouterTrace

invokedModelId

  • Type: typing.Optional[str]

PromptVariableValues

text

  • Type: typing.Optional[str]

ReasoningContentBlock

reasoningText

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ReasoningTextBlock]

redactedContent

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

ReasoningContentBlockDelta

text

  • Type: typing.Optional[str]

redactedContent

  • Type: typing.Optional[bytes]

signature

  • Type: typing.Optional[str]

ReasoningContentBlockOutput

reasoningText

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ReasoningTextBlock]

redactedContent

  • Type: typing.Optional[bytes]

ReasoningTextBlock

text

  • Type:
  • Required: Yes

signature

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

ResponseStream

chunk

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.PayloadPart]

internalServerException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.InternalServerException]

modelStreamErrorException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ModelStreamErrorException]

validationException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ValidationException]

throttlingException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ThrottlingException]

modelTimeoutException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ModelTimeoutException]

serviceUnavailableException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ServiceUnavailableException]

S3Location

uri

  • Type:
  • Required: Yes

bucketOwner

  • Type: typing.Optional[str]

ServiceUnavailableException

message

  • Type: typing.Optional[str]

SpecificToolChoice

name

  • Type:
  • Required: Yes

StartAsyncInvokeRequest

modelId

  • Type:
  • Required: Yes

modelInput

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

outputDataConfig

  • Type:
  • Required: Yes

clientRequestToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.Tag]]

StartAsyncInvokeResponse

invocationArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SystemContentBlock

text

  • Type: typing.Optional[str]

guardContent

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseContentBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.GuardrailConverseContentBlockOutput, NoneType]

Tag

key

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

ThrottlingException

message

  • Type: typing.Optional[str]

TokenUsage

inputTokens

  • Type:
  • Required: Yes

outputTokens

  • Type:
  • Required: Yes

totalTokens

  • Type:
  • Required: Yes

Tool

toolSpec

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolSpecification]

ToolChoice

auto

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

any

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

tool

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.SpecificToolChoice]

ToolConfiguration

tools

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.Tool]
  • Required: Yes

toolChoice

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolChoice]

ToolInputSchema

json

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

ToolResultBlock

toolUseId

  • Type:
  • Required: Yes

content

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolResultContentBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolResultContentBlockOutput]]
  • Required: Yes

status

  • Type: typing.Optional[typing.Literal['error', 'success']]

ToolResultBlockOutput

toolUseId

  • Type:
  • Required: Yes

content

  • Type: typing.List[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ToolResultContentBlockOutput]
  • Required: Yes

status

  • Type: typing.Optional[typing.Literal['error', 'success']]

ToolResultContentBlock

json

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

text

  • Type: typing.Optional[str]

image

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ImageBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ImageBlockOutput, NoneType]

document

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.DocumentBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.DocumentBlockOutput, NoneType]

video

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.VideoBlock, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.VideoBlockOutput, NoneType]

ToolResultContentBlockOutput

json

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

text

  • Type: typing.Optional[str]

image

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.ImageBlockOutput]

document

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.DocumentBlockOutput]

video

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.VideoBlockOutput]

ToolSpecification

name

  • Type:
  • Required: Yes

inputSchema

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

ToolUseBlock

toolUseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

input

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

ToolUseBlockDelta

input

  • Type:
  • Required: Yes

ToolUseBlockOutput

toolUseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

input

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

ToolUseBlockStart

toolUseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

ValidationException

message

  • Type: typing.Optional[str]

VideoBlock

format

  • Type: typing.Literal['flv', 'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'three_gp', 'webm', 'wmv']
  • Required: Yes

source

  • Type: typing.Union[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.VideoSource, aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.VideoSourceOutput]
  • Required: Yes

VideoBlockOutput

format

  • Type: typing.Literal['flv', 'mkv', 'mov', 'mp4', 'mpeg', 'mpg', 'three_gp', 'webm', 'wmv']
  • Required: Yes

source

  • Type:
  • Required: Yes

VideoSource

bytes

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

s3Location

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.S3Location]

VideoSourceOutput

bytes

  • Type:

s3Location

  • Type: typing.Optional[aws_resource_validator.pydantic_models.bedrock_runtime.bedrock_runtime_classes.S3Location]