ResponseStream module-attribute

ResponseStream = Union[ResponseStreamChunk | ResponseStreamInternalServerException | ResponseStreamModelStreamErrorException | ResponseStreamValidationException | ResponseStreamThrottlingException | ResponseStreamModelTimeoutException | ResponseStreamServiceUnavailableException | ResponseStreamUnknown]

Definition of content in the response stream.

Union Members

ResponseStreamChunk dataclass

Content included in the response.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ResponseStreamChunk:
    """Content included in the response."""

    value: PayloadPart

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_RESPONSE_STREAM, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_RESPONSE_STREAM.members["chunk"], self.value)

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=PayloadPart.deserialize(deserializer))

ResponseStreamInternalServerException dataclass

An internal server error occurred. Retry your request.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ResponseStreamInternalServerException:
    """An internal server error occurred. Retry your request."""

    value: InternalServerException

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_RESPONSE_STREAM, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_RESPONSE_STREAM.members["internalServerException"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=InternalServerException.deserialize(deserializer))

ResponseStreamModelStreamErrorException dataclass

An error occurred while streaming the response. Retry your request.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ResponseStreamModelStreamErrorException:
    """An error occurred while streaming the response. Retry your request."""

    value: ModelStreamErrorException

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_RESPONSE_STREAM, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_RESPONSE_STREAM.members["modelStreamErrorException"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=ModelStreamErrorException.deserialize(deserializer))

ResponseStreamValidationException dataclass

Input validation failed. Check your request parameters and retry the request.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ResponseStreamValidationException:
    """Input validation failed. Check your request parameters and retry the
    request.
    """

    value: ValidationException

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_RESPONSE_STREAM, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_RESPONSE_STREAM.members["validationException"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=ValidationException.deserialize(deserializer))

ResponseStreamThrottlingException dataclass

Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ResponseStreamThrottlingException:
    """Your request was throttled because of service-wide limitations. Resubmit
    your request later or in a different region. You can also purchase
    [Provisioned
    Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
    to increase the rate or number of tokens you can process.
    """

    value: ThrottlingException

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_RESPONSE_STREAM, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_RESPONSE_STREAM.members["throttlingException"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=ThrottlingException.deserialize(deserializer))

ResponseStreamModelTimeoutException dataclass

The request took too long to process. Processing time exceeded the model timeout length.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ResponseStreamModelTimeoutException:
    """The request took too long to process. Processing time exceeded the model
    timeout length.
    """

    value: ModelTimeoutException

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_RESPONSE_STREAM, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_RESPONSE_STREAM.members["modelTimeoutException"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=ModelTimeoutException.deserialize(deserializer))

ResponseStreamServiceUnavailableException dataclass

The service isn't available. Try again later.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ResponseStreamServiceUnavailableException:
    """The service isn't available. Try again later."""

    value: ServiceUnavailableException

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_RESPONSE_STREAM, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_RESPONSE_STREAM.members["serviceUnavailableException"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=ServiceUnavailableException.deserialize(deserializer))

ResponseStreamUnknown 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.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ResponseStreamUnknown:
    """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.
    """

    tag: str

    def serialize(self, serializer: ShapeSerializer):
        raise SerializationError("Unknown union variants may not be serialized.")

    def serialize_members(self, serializer: ShapeSerializer):
        raise SerializationError("Unknown union variants may not be serialized.")

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        raise NotImplementedError()