smithy-client/aws.smithy.kotlin.runtime.client/Interceptor

Interceptor

interface Interceptor<Input, Output, ProtocolRequest, ProtocolResponse>

An interceptor allows injecting code into the request execution pipeline of a generated SDK client.

Terminology:

execution - one end-to-end invocation against an SDK client
attempt - a single attempt at performing an execution, executions may be retired multiple times based on the client's retry strategy.
hook - a single method on the interceptor allowing injection of code into a specific part of the execution pipeline. Hooks are either "read-only" hooks, which make it possible to read in-flight request or response messages, or read/write hooks, which make it possible to modify in-flight request or response messages. Read only hooks MUST not modify state even if it is possible to do so (it is not always possible or performant to provide an immutable view of every type).

Functions

open suspend fun modifyBeforeAttemptCompletion(context: ResponseInterceptorContext<Input, Output, ProtocolRequest, ProtocolResponse?>): <Error class: unknown class><Output>

A hook called when an attempt is completed. This method has the ability to modify and return a new operation output or error.

modifyBeforeCompletion

open suspend fun modifyBeforeCompletion(context: ResponseInterceptorContext<Input, Output, ProtocolRequest?, ProtocolResponse?>): <Error class: unknown class><Output>

A hook called when an attempt is completed. This method has the ability to modify and return a new operation output or error.

modifyBeforeDeserialization

open suspend fun modifyBeforeDeserialization(context: ProtocolResponseInterceptorContext<Input, ProtocolRequest, ProtocolResponse>): ProtocolResponse

A hook called before the transport request message is deserialized into the output response type. This method has the ability to modify and return a new transport response.

modifyBeforeRetryLoop

open suspend fun modifyBeforeRetryLoop(context: ProtocolRequestInterceptorContext<Input, ProtocolRequest>): ProtocolRequest

A hook called before the retry loop is entered. This method has the ability to modify and return a new transport request.

modifyBeforeSerialization

open suspend fun modifyBeforeSerialization(context: RequestInterceptorContext<Input>): Input

A hook called before the input message is marshalled into a (protocol) transport message. This method has the ability to modify and return a new operation request.

modifyBeforeSigning

open suspend fun modifyBeforeSigning(context: ProtocolRequestInterceptorContext<Input, ProtocolRequest>): ProtocolRequest

A hook called before the transport request message is signed. This method has the ability to modify and return a new transport request.

modifyBeforeTransmit

open suspend fun modifyBeforeTransmit(context: ProtocolRequestInterceptorContext<Input, ProtocolRequest>): ProtocolRequest

A hook called before the transport request message is sent to the service. This method has the ability to modify and return a new transport request.

readAfterAttempt

open fun readAfterAttempt(context: ResponseInterceptorContext<Input, Output, ProtocolRequest, ProtocolResponse?>)

A hook called when an attempt is completed.

readAfterDeserialization

open fun readAfterDeserialization(context: ResponseInterceptorContext<Input, Output, ProtocolRequest, ProtocolResponse>)

A hook called after the transport request message is deserialized into the output response type.

readAfterExecution

open fun readAfterExecution(context: ResponseInterceptorContext<Input, Output, ProtocolRequest?, ProtocolResponse?>)

A hook called when an attempt is completed.

readAfterSerialization

open fun readAfterSerialization(context: ProtocolRequestInterceptorContext<Input, ProtocolRequest>)

A hook called after the input message is marshalled into a (protocol) transport message.

readAfterSigning

open fun readAfterSigning(context: ProtocolRequestInterceptorContext<Input, ProtocolRequest>)

A hook called after the transport request message is signed.

readAfterTransmit

open fun readAfterTransmit(context: ProtocolResponseInterceptorContext<Input, ProtocolRequest, ProtocolResponse>)

A hook called after the transport response message is received from the service.

readBeforeAttempt

open fun readBeforeAttempt(context: ProtocolRequestInterceptorContext<Input, ProtocolRequest>)

A hook called before each attempt at sending the protocol request message to the service.

readBeforeDeserialization

open fun readBeforeDeserialization(context: ProtocolResponseInterceptorContext<Input, ProtocolRequest, ProtocolResponse>)

A hook called before the transport request message is deserialized into the output response type.

readBeforeExecution

open fun readBeforeExecution(context: RequestInterceptorContext<Input>)

A hook called at the start of an execution, before the SDK does anything else.

readBeforeSerialization

open fun readBeforeSerialization(context: RequestInterceptorContext<Input>)

A hook called before the input message is marshalled into a (protocol) transport message.

readBeforeSigning

open fun readBeforeSigning(context: ProtocolRequestInterceptorContext<Input, ProtocolRequest>)

A hook called before the transport request message is signed.

readBeforeTransmit

open fun readBeforeTransmit(context: ProtocolRequestInterceptorContext<Input, ProtocolRequest>)

A hook called before the transport request message is sent to the service.