Skip to content

Bedrock Runtime  >  Unions  >  ConverseStreamOutput

ConverseStreamOutput

Union Type

ConverseStreamOutput module-attribute 

ConverseStreamOutput = Union[ConverseStreamOutputMessageStart | ConverseStreamOutputContentBlockStart | ConverseStreamOutputContentBlockDelta | ConverseStreamOutputContentBlockStop | ConverseStreamOutputMessageStop | ConverseStreamOutputMetadata | ConverseStreamOutputInternalServerException | ConverseStreamOutputModelStreamErrorException | ConverseStreamOutputValidationException | ConverseStreamOutputThrottlingException | ConverseStreamOutputServiceUnavailableException | ConverseStreamOutputUnknown]

The messages output stream

Union Member Types

ConverseStreamOutputMessageStart dataclass

Message start information.

Attributes

value instance-attribute 
value: MessageStartEvent

ConverseStreamOutputContentBlockStart dataclass

Start information for a content block.

Attributes

value instance-attribute 
value: ContentBlockStartEvent

ConverseStreamOutputContentBlockDelta dataclass

The messages output content block delta.

Attributes

value instance-attribute 
value: ContentBlockDeltaEvent

ConverseStreamOutputContentBlockStop dataclass

Stop information for a content block.

Attributes

value instance-attribute 
value: ContentBlockStopEvent

ConverseStreamOutputMessageStop dataclass

Message stop information.

Attributes

value instance-attribute 
value: MessageStopEvent

ConverseStreamOutputMetadata dataclass

Metadata for the converse output stream.

Attributes

value instance-attribute 
value: ConverseStreamMetadataEvent

ConverseStreamOutputInternalServerException dataclass

An internal server error occurred. Retry your request.

Attributes

value instance-attribute 
value: InternalServerException

ConverseStreamOutputModelStreamErrorException dataclass

A streaming error occurred. Retry your request.

Attributes

value instance-attribute 
value: ModelStreamErrorException

ConverseStreamOutputValidationException dataclass

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.

Attributes

value instance-attribute 
value: ValidationException

ConverseStreamOutputThrottlingException dataclass

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide.

Attributes

value instance-attribute 
value: ThrottlingException

ConverseStreamOutputServiceUnavailableException dataclass

The service isn't currently available. For troubleshooting this error, see ServiceUnavailable in the Amazon Bedrock User Guide

Attributes

value instance-attribute 
value: ServiceUnavailableException

ConverseStreamOutputUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute 
tag: str