http-client/aws.smithy.kotlin.runtime.http.operation

Package-level declarations

Types

class AttemptTimeoutException(message: String, cause: Throwable) : ClientTimeoutException

Indicates that a single attempt took longer than allowed to complete

Type agnostic version of AuthSchemeProvider. Typically service client specific versions are code generated and then adapted to this generic version for actually executing a request.

CallTimeoutException

class CallTimeoutException(message: String, cause: Throwable) : ClientTimeoutException

Indicates that a call (including any retry attempts) took longer than allowed to complete

ClientTimeoutException

abstract class ClientTimeoutException(message: String, cause: Throwable, retryable: Boolean)

Indicates that a client-side configured timeout was exceeded (e.g., call timeout, attempt timeout, etc.)

EndpointResolver

fun interface EndpointResolver

Type agnostic version of aws.smithy.kotlin.runtime.client.endpoints.EndpointProvider. Typically service client specific versions are code generated and then adapted to this generic version for actually executing a request.

HttpDeserializer

sealed interface HttpDeserializer<T>

Implemented by types that know how to deserialize from the HTTP protocol.

HttpOperationContext

object HttpOperationContext

Common configuration for an SDK (HTTP) operation/call

HttpSerializer

sealed interface HttpSerializer<T>

Implemented by types that know how to serialize to the HTTP protocol.

InitializeMiddleware

interface InitializeMiddleware<Request, Response>

Middleware that intercepts the SdkOperationExecution.initialize phase

InlineMiddleware

interface InlineMiddleware<I, O>

A middleware that directly registers interceptors onto an operation inline in install. This can be useful for example if a middleware needs to hook into multiple phases:

ModifyRequestMiddleware

interface ModifyRequestMiddleware

A middleware that only mutates the outgoing SdkHttpRequest.

MutateMiddleware

interface MutateMiddleware<Response>

Middleware that intercepts the SdkOperationExecution.mutate phase

OperationAuthConfig

data class OperationAuthConfig(val authSchemeResolver: AuthSchemeResolver, val configuredAuthSchemes: Map<<Error class: unknown class>, <Error class: unknown class>>, val identityProviderConfig: <Error class: unknown class>)

Container for authentication configuration for an operation

OperationMetrics

class OperationMetrics(scope: String, val provider: <Error class: unknown class>)

Container for common operation/call metrics

OperationRequest

data class OperationRequest<T>(val context: <Error class: unknown class>, val subject: T)

Wrapper around a type subject with an execution context.

ReceiveMiddleware

interface ReceiveMiddleware

Middleware that intercepts the SdkOperationExecution.receive phase

ResolveEndpointRequest

data class ResolveEndpointRequest(val context: <Error class: unknown class>, val httpRequest: <Error class: unknown class>, val identity: <Error class: unknown class>)

Context for EndpointResolver implementations used to drive endpoint resolution

SdkHttpOperation

class SdkHttpOperation<I, O>

A (Smithy) HTTP based operation.

SdkHttpOperationBuilder

class SdkHttpOperationBuilder<I, O>(inputType: KClass<*>, outputType: KClass<*>)

SdkHttpRequest

typealias SdkHttpRequest = OperationRequest<<Error class: unknown class>>

SdkOperationExecution

class SdkOperationExecution<Request, Response>

Configure the execution of an operation from Request to Response.

SdkOperationTelemetry

class SdkOperationTelemetry

Telemetry parameters used to instrument an operation

Inherited properties

sdkInvocationId

val <Error class: unknown class>.sdkInvocationId: String

Gets the unique ID that identifies the active SDK request in this ExecutionContext.

Functions

setResolvedEndpoint

fun setResolvedEndpoint(req: SdkHttpRequest, endpoint: <Error class: unknown class>)

fun setResolvedEndpoint(req: <Error class: unknown class>, ctx: <Error class: unknown class>, endpoint: <Error class: unknown class>)

Update an existing request with a resolved endpoint.

Inherited functions

context

inline fun <I, O> SdkHttpOperationBuilder<I, O>.context(block: <Error class: unknown class>.() -> Unit)

Configure HTTP operation context elements

execute

suspend fun <I, O, R> SdkHttpOperation<I, O>.execute(httpHandler: <Error class: unknown class><SdkHttpRequest, <Error class: unknown class>>, input: I, block: suspend (O) -> R): R

Make an operation request with the given input and return the result of executing block with the output.

roundTrip

suspend fun <I, O> SdkHttpOperation<I, O>.roundTrip(httpHandler: <Error class: unknown class><SdkHttpRequest, <Error class: unknown class>>, input: I): O

Round trip an operation using the given HttpHandler

telemetry

inline fun <I, O> SdkHttpOperationBuilder<I, O>.telemetry(block: SdkOperationTelemetry.() -> Unit)

Configure operation telemetry parameters