runtime-core/aws.smithy.kotlin.runtime

Package-level declarations

Types

class ClientErrorContext(val key: String, val value: String)

Describes additional context about an error which may be useful in client-side debugging. This information will be included in exception messages. This contrasts with ErrorMetadata which is not necessarily included in messages and not necessarily client-related.

ClientException

open class ClientException : SdkBaseException

Base exception class for any errors that occur while attempting to use an SDK client to make (Smithy) service calls.

ErrorMetadata

open class ErrorMetadata

Additional metadata about an error

ExperimentalApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR])

annotation class ExperimentalApi

API marked with this annotation is experimental and has a high chance of being changed or even removed. Do not use it if you develop a library since your library will become binary incompatible with future versions of the runtime.

IgnoreNative

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

expect annotation class IgnoreNative

Marks a test that should be ignored on Native platforms

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

actual annotation class IgnoreNative

actual typealias IgnoreNative = Ignore

InternalApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR])

annotation class InternalApi

API marked with this annotation is internal to the runtime, and it is not intended to be used outside. It could be modified or removed without any notice. Using it outside the runtime (or generated code) could cause undefined behaviour and/or any strange effects.

PlannedRemoval

annotation class PlannedRemoval(val major: Int, val minor: Int)

Indicates that the annotated API is deprecated and scheduled for removal in an upcoming version. Any code using this API should migrate to the suggested replacement as soon as possible.

ProtocolResponse

interface ProtocolResponse

Generic interface that any protocol (e.g. HTTP, MQTT, etc) can extend to provide additional access to protocol specific details.

SdkBaseException

open class SdkBaseException : RuntimeException

Base exception class for all exceptions thrown by the SDK. Exception may be a client side exception or a service exception

SdkDsl

@DslMarker

annotation class SdkDsl

Signifies that a type is considered part of an SDK DSL for the purposes of scope control

ServiceErrorMetadata

open class ServiceErrorMetadata : ErrorMetadata

ServiceException

open class ServiceException : SdkBaseException

ServiceException - Base exception class for any error response returned by a service. Receiving an exception of this type indicates that the caller's request was successfully transmitted to the service and the service sent back an error response.