middleware

Documentation

Index

• func AddClientRequestIDMiddleware(stack *middleware.Stack) error
• func AddRawResponseToMetadata(stack *middleware.Stack) error
• func AddRecordResponseTiming(stack *middleware.Stack) error
• func AddRecursionDetection(stack *middleware.Stack) error
• func AddRequestIDRetrieverMiddleware(stack *middleware.Stack) error
• func AddRequestUserAgentMiddleware(stack *middleware.Stack) error
• func AddSDKAgentKey(keyType SDKAgentKeyType, key string) func(*middleware.Stack) error
• func AddSDKAgentKeyValue(keyType SDKAgentKeyType, key, value string) func(*middleware.Stack) error
• func AddUserAgentKey(key string) func(*middleware.Stack) error
• func AddUserAgentKeyValue(key, value string) func(*middleware.Stack) error
• func GetAttemptSkew(metadata middleware.Metadata) (v time.Duration, ok bool)
• func GetEndpointSource(ctx context.Context) (v aws.EndpointSource)
• func GetOperationName(ctx context.Context) (v string)
• func GetPartitionID(ctx context.Context) string
• func GetRawResponse(metadata middleware.Metadata) interface{}
• func GetRegion(ctx context.Context) (v string)
• func GetRequestIDMetadata(metadata middleware.Metadata) (string, bool)
• func GetRequiresLegacyEndpoints(ctx context.Context) bool
• func GetResponseAt(metadata middleware.Metadata) (v time.Time, ok bool)
• func GetServerTime(metadata middleware.Metadata) (v time.Time, ok bool)
• func GetServiceID(ctx context.Context) (v string)
• func GetSigningCredentials(ctx context.Context) (v aws.Credentials)
• func GetSigningName(ctx context.Context) (v string)
• func GetSigningRegion(ctx context.Context) (v string)
• func SetEndpointSource(ctx context.Context, value aws.EndpointSource) context.Context
• func SetPartitionID(ctx context.Context, value string) context.Context
• func SetRequestIDMetadata(metadata *middleware.Metadata, id string)
• func SetRequiresLegacyEndpoints(ctx context.Context, value bool) context.Context
• func SetServiceID(ctx context.Context, value string) context.Context
• func SetSigningCredentials(ctx context.Context, value aws.Credentials) context.Context
• func SetSigningName(ctx context.Context, value string) context.Context
• func SetSigningRegion(ctx context.Context, value string) context.Context
• type ClientRequestID
  • func (r ClientRequestID) HandleBuild(ctx context.Context, in middleware.BuildInput, next middleware.BuildHandler) (out middleware.BuildOutput, metadata middleware.Metadata, err error)
  • func (r *ClientRequestID) ID() string
• type RecordResponseTiming
  • func (a RecordResponseTiming) HandleDeserialize(ctx context.Context, in middleware.DeserializeInput, ...) (out middleware.DeserializeOutput, metadata middleware.Metadata, err error)
  • func (a *RecordResponseTiming) ID() string
• type RecursionDetection
  • func (m *RecursionDetection) HandleBuild(ctx context.Context, in middleware.BuildInput, next middleware.BuildHandler) (out middleware.BuildOutput, metadata middleware.Metadata, err error)
  • func (m *RecursionDetection) ID() string
• type RegisterServiceMetadata
  • func (s RegisterServiceMetadata) HandleInitialize(ctx context.Context, in middleware.InitializeInput, ...) (out middleware.InitializeOutput, metadata middleware.Metadata, err error)
  • func (s *RegisterServiceMetadata) ID() string
• type SDKAgentKeyType

Functions

func AddClientRequestIDMiddleware

func AddClientRequestIDMiddleware(stack *middleware.Stack) error

AddClientRequestIDMiddleware adds ClientRequestID to the middleware stack

func AddRawResponseToMetadata

func AddRawResponseToMetadata(stack *middleware.Stack) error

AddRawResponseToMetadata adds middleware to the middleware stack that store raw response on to the metadata.

func AddRecordResponseTiming

func AddRecordResponseTiming(stack *middleware.Stack) error

AddRecordResponseTiming adds RecordResponseTiming middleware to the middleware stack.

func AddRecursionDetection

func AddRecursionDetection(stack *middleware.Stack) error

AddRecursionDetection adds recursionDetection to the middleware stack

func AddRequestIDRetrieverMiddleware

func AddRequestIDRetrieverMiddleware(stack *middleware.Stack) error

AddRequestIDRetrieverMiddleware adds request id retriever middleware

func AddRequestUserAgentMiddleware

func AddRequestUserAgentMiddleware(stack *middleware.Stack) error

AddRequestUserAgentMiddleware registers a requestUserAgent middleware on the stack if not present.

func AddSDKAgentKey

func AddSDKAgentKey(keyType SDKAgentKeyType, key string) func(*middleware.Stack) error

AddSDKAgentKey retrieves a requestUserAgent from the provided stack, or initializes one.

func AddSDKAgentKeyValue

func AddSDKAgentKeyValue(keyType SDKAgentKeyType, key, value string) func(*middleware.Stack) error

AddSDKAgentKeyValue retrieves a requestUserAgent from the provided stack, or initializes one.

func AddUserAgentKey

func AddUserAgentKey(key string) func(*middleware.Stack) error

AddUserAgentKey retrieves a requestUserAgent from the provided stack, or initializes one.

func AddUserAgentKeyValue

func AddUserAgentKeyValue(key, value string) func(*middleware.Stack) error

AddUserAgentKeyValue retrieves a requestUserAgent from the provided stack, or initializes one.

func GetAttemptSkew

func GetAttemptSkew(metadata middleware.Metadata) (v time.Duration, ok bool)

GetAttemptSkew returns Attempt clock skew for response from metadata.

func GetEndpointSource

func GetEndpointSource(ctx context.Context) (v aws.EndpointSource)

GetEndpointSource returns an endpoint source if set on context

func GetOperationName

func GetOperationName(ctx context.Context) (v string)

GetOperationName retrieves the service operation metadata from the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func GetPartitionID

func GetPartitionID(ctx context.Context) string

GetPartitionID retrieves the endpoint partition id from the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func GetRawResponse

func GetRawResponse(metadata middleware.Metadata) interface{}

GetRawResponse returns raw response set on metadata

func GetRegion

func GetRegion(ctx context.Context) (v string)

GetRegion retrieves the endpoint region from the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func GetRequestIDMetadata

func GetRequestIDMetadata(metadata middleware.Metadata) (string, bool)

GetRequestIDMetadata retrieves the request id from middleware metadata returns string and bool indicating value of request id, whether request id was set.

func GetRequiresLegacyEndpoints

func GetRequiresLegacyEndpoints(ctx context.Context) bool

GetRequiresLegacyEndpoints the flag used to indicate if legacy endpoint customizations need to be executed.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func GetResponseAt

func GetResponseAt(metadata middleware.Metadata) (v time.Time, ok bool)

GetResponseAt returns the time response was received at.

func GetServerTime

func GetServerTime(metadata middleware.Metadata) (v time.Time, ok bool)

GetServerTime returns the server time for response.

func GetServiceID

func GetServiceID(ctx context.Context) (v string)

GetServiceID retrieves the service id from the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func GetSigningCredentials

func GetSigningCredentials(ctx context.Context) (v aws.Credentials)

GetSigningCredentials returns the credentials that were used for signing if set on context.

func GetSigningName

func GetSigningName(ctx context.Context) (v string)

GetSigningName retrieves the service signing name from the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

Deprecated: This value is unstable. The resolved signing name is available in the signer properties object passed to the signer.

func GetSigningRegion

func GetSigningRegion(ctx context.Context) (v string)

GetSigningRegion retrieves the region from the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

Deprecated: This value is unstable. The resolved signing region is available in the signer properties object passed to the signer.

func SetEndpointSource

func SetEndpointSource(ctx context.Context, value aws.EndpointSource) context.Context

SetEndpointSource sets endpoint source on context

func SetPartitionID

func SetPartitionID(ctx context.Context, value string) context.Context

SetPartitionID sets the partition id of a resolved region on the context

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func SetRequestIDMetadata

func SetRequestIDMetadata(metadata *middleware.Metadata, id string)

SetRequestIDMetadata sets the provided request id over middleware metadata

func SetRequiresLegacyEndpoints

func SetRequiresLegacyEndpoints(ctx context.Context, value bool) context.Context

SetRequiresLegacyEndpoints set or modifies the flag indicated that legacy endpoint customizations are needed.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func SetServiceID

func SetServiceID(ctx context.Context, value string) context.Context

SetServiceID sets the service id on the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

func SetSigningCredentials

func SetSigningCredentials(ctx context.Context, value aws.Credentials) context.Context

SetSigningCredentials sets the credentails used for signing on the context.

func SetSigningName

func SetSigningName(ctx context.Context, value string) context.Context

SetSigningName set or modifies the sigv4 or sigv4a signing name on the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

Deprecated: This value is unstable. Use WithSigV4SigningName client option funcs instead.

func SetSigningRegion

func SetSigningRegion(ctx context.Context, value string) context.Context

SetSigningRegion sets or modifies the region on the context.

Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.

Deprecated: This value is unstable. Use WithSigV4SigningRegion client option funcs instead.

Types

type ClientRequestID

type ClientRequestID struct{}

ClientRequestID is a Smithy BuildMiddleware that will generate a unique ID for logical API operation invocation.

func (ClientRequestID) HandleBuild

func (r ClientRequestID) HandleBuild(ctx context.Context, in middleware.BuildInput, next middleware.BuildHandler) (
	out middleware.BuildOutput, metadata middleware.Metadata, err error,
)

HandleBuild attaches a unique operation invocation id for the operation to the request

func (*ClientRequestID) ID

func (r *ClientRequestID) ID() string

ID the identifier for the ClientRequestID

type RecordResponseTiming

type RecordResponseTiming struct{}

RecordResponseTiming records the response timing for the SDK client requests.

func (RecordResponseTiming) HandleDeserialize

func (a RecordResponseTiming) HandleDeserialize(ctx context.Context, in middleware.DeserializeInput, next middleware.DeserializeHandler) (
	out middleware.DeserializeOutput, metadata middleware.Metadata, err error,
)

HandleDeserialize calculates response metadata and clock skew

func (*RecordResponseTiming) ID

func (a *RecordResponseTiming) ID() string

ID is the middleware identifier

type RecursionDetection

type RecursionDetection struct{}

RecursionDetection detects Lambda environment and sets its X-Ray trace ID to request header if absent to avoid recursion invocation in Lambda

func (*RecursionDetection) HandleBuild

func (m *RecursionDetection) HandleBuild(
	ctx context.Context, in middleware.BuildInput, next middleware.BuildHandler,
) (
	out middleware.BuildOutput, metadata middleware.Metadata, err error,
)

HandleBuild detects Lambda environment and adds its trace ID to request header if absent

func (*RecursionDetection) ID

func (m *RecursionDetection) ID() string

ID returns the middleware identifier

type RegisterServiceMetadata

type RegisterServiceMetadata struct {
	ServiceID     string
	SigningName   string
	Region        string
	OperationName string
}

RegisterServiceMetadata registers metadata about the service and operation into the middleware context so that it is available at runtime for other middleware to introspect.

func (RegisterServiceMetadata) HandleInitialize

func (s RegisterServiceMetadata) HandleInitialize(
	ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler,
) (out middleware.InitializeOutput, metadata middleware.Metadata, err error)

HandleInitialize registers service metadata information into the middleware context, allowing for introspection.

func (*RegisterServiceMetadata) ID

func (s *RegisterServiceMetadata) ID() string

ID returns the middleware identifier.

type SDKAgentKeyType

type SDKAgentKeyType int

SDKAgentKeyType is the metadata type to add to the SDK agent string

const (
	APIMetadata SDKAgentKeyType
	OperatingSystemMetadata
	LanguageMetadata
	EnvironmentMetadata
	FeatureMetadata
	ConfigMetadata
	FrameworkMetadata
	AdditionalMetadata
	ApplicationIdentifier
)

The set of valid SDKAgentKeyType constants. If an unknown value is assigned for SDKAgentKeyType it will be mapped to AdditionalMetadata.