Documentation
¶
Index ¶
- func AddClientRequestIDMiddleware(stack *middleware.Stack) error
- func AddRawResponseToMetadata(stack *middleware.Stack) error
- func AddRecordResponseTiming(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 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 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
- type RecordResponseTiming
- type RegisterServiceMetadata
- type SDKAgentKeyType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 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 ¶
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 ¶
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 ¶
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 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 ¶
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 ¶
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.
func GetSigningRegion ¶
GetSigningRegion retrieves the region from the context.
Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.
func SetEndpointSource ¶
SetEndpointSource sets endpoint source on context
func SetPartitionID ¶
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 SetServiceID ¶
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 ¶
SetSigningCredentials sets the credentails used for signing on the context.
func SetSigningName ¶
SetSigningName set or modifies the signing name on the context.
Scoped to stack values. Use github.com/aws/smithy-go/middleware#ClearStackValues to clear all stack values.
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 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.
Source Files