Package: middleware

import "../ibm-cos-sdk-go-v2/aws/middleware"

Constants

const _ SDKAgentKeyType = readonly

Value:

iota
const UserAgentFeatureResourceModel UserAgentFeature = readonly

Value:

"A" // n/a (we don't generate separate resource types)
const UserAgentFeatureWaiter = readonly

Value:

"B"
const UserAgentFeaturePaginator = readonly

Value:

"C"
const UserAgentFeatureRetryModeLegacy = readonly

Value:

"D" // n/a (equivalent to standard)
const UserAgentFeatureRetryModeStandard = readonly

Value:

"E"
const UserAgentFeatureRetryModeAdaptive = readonly

Value:

"F"
const UserAgentFeatureS3Transfer = readonly

Value:

"G"
const UserAgentFeatureS3CryptoV1N = readonly

Value:

"H" // n/a (crypto client is external)
const UserAgentFeatureS3CryptoV2 = readonly

Value:

"I" // n/a
const UserAgentFeatureS3ExpressBucket = readonly

Value:

"J"
const UserAgentFeatureS3AccessGrants = readonly

Value:

"K" // not yet implemented
const UserAgentFeatureGZIPRequestCompression = readonly

Value:

"L"
const UserAgentFeatureProtocolRPCV2CBOR = readonly

Value:

"M"
const UserAgentFeatureAccountIDEndpoint = readonly

Value:

"O" // DO NOT IMPLEMENT: rules output is not currently defined. SDKs should not parse endpoints for feature information.
const UserAgentFeatureAccountIDModePreferred = readonly

Value:

"P"
const UserAgentFeatureAccountIDModeDisabled = readonly

Value:

"Q"
const UserAgentFeatureAccountIDModeRequired = readonly

Value:

"R"
const UserAgentFeatureRequestChecksumCRC32 = readonly

Value:

"U"
const UserAgentFeatureRequestChecksumCRC32C = readonly

Value:

"V"
const UserAgentFeatureRequestChecksumCRC64 = readonly

Value:

"W"
const UserAgentFeatureRequestChecksumSHA1 = readonly

Value:

"X"
const UserAgentFeatureRequestChecksumSHA256 = readonly

Value:

"Y"
const UserAgentFeatureRequestChecksumWhenSupported = readonly

Value:

"Z"
const UserAgentFeatureRequestChecksumWhenRequired = readonly

Value:

"a"
const UserAgentFeatureResponseChecksumWhenSupported = readonly

Value:

"b"
const UserAgentFeatureResponseChecksumWhenRequired = readonly

Value:

"c"
const UserAgentFeatureDynamoDBUserAgent = readonly

Value:

"d" // not yet implemented
const UserAgentFeatureCredentialsCode = readonly

Value:

"e"
const UserAgentFeatureCredentialsJvmSystemProperties = readonly

Value:

"f" // n/a (this is not a JVM sdk)
const UserAgentFeatureCredentialsEnvVars = readonly

Value:

"g"
const UserAgentFeatureCredentialsEnvVarsStsWebIDToken = readonly

Value:

"h"
const UserAgentFeatureCredentialsStsAssumeRole = readonly

Value:

"i"
const UserAgentFeatureCredentialsStsAssumeRoleSaml = readonly

Value:

"j" // not yet implemented
const UserAgentFeatureCredentialsStsAssumeRoleWebID = readonly

Value:

"k"
const UserAgentFeatureCredentialsStsFederationToken = readonly

Value:

"l" // not yet implemented
const UserAgentFeatureCredentialsStsSessionToken = readonly

Value:

"m" // not yet implemented
const UserAgentFeatureCredentialsProfile = readonly

Value:

"n"
const UserAgentFeatureCredentialsProfileSourceProfile = readonly

Value:

"o"
const UserAgentFeatureCredentialsProfileNamedProvider = readonly

Value:

"p"
const UserAgentFeatureCredentialsProfileStsWebIDToken = readonly

Value:

"q"
const UserAgentFeatureCredentialsProfileSso = readonly

Value:

"r"
const UserAgentFeatureCredentialsSso = readonly

Value:

"s"
const UserAgentFeatureCredentialsProfileSsoLegacy = readonly

Value:

"t"
const UserAgentFeatureCredentialsSsoLegacy = readonly

Value:

"u"
const UserAgentFeatureCredentialsProfileProcess = readonly

Value:

"v"
const UserAgentFeatureCredentialsProcess = readonly

Value:

"w"
const UserAgentFeatureCredentialsBoto2ConfigFile = readonly

Value:

"x" // n/a (this is not boto/Python)
const UserAgentFeatureCredentialsAwsSdkStore = readonly

Value:

"y" // n/a (this is used by .NET based sdk)
const UserAgentFeatureCredentialsHTTP = readonly

Value:

"z"
const UserAgentFeatureCredentialsIMDS = readonly

Value:

"0"

Type Summary collapse

Function Summary collapse

Function Details

func AddClientRequestIDMiddleware(stack *middleware.Stack) error

AddClientRequestIDMiddleware adds ClientRequestID to the middleware stack



127
128
129
 
// File 'aws/middleware/middleware.go', line 127


func AddClientRequestIDMiddleware(stack *middleware.Stack) error {
	return stack.Build.Add(&ClientRequestID{}, middleware.After)
}

func AddRawResponseToMetadata(stack *middleware.Stack) error

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



160
161
162
 
// File 'aws/middleware/middleware.go', line 160


func AddRawResponseToMetadata(stack *middleware.Stack) error {
	return stack.Deserialize.Add(&AddRawResponse{}, middleware.Before)
}

func AddRecordResponseTiming(stack *middleware.Stack) error

AddRecordResponseTiming adds RecordResponseTiming middleware to the middleware stack.



133
134
135
 
// File 'aws/middleware/middleware.go', line 133


func AddRecordResponseTiming(stack *middleware.Stack) error {
	return stack.Deserialize.Add(&RecordResponseTiming{}, middleware.After)
}

func AddRecursionDetection(stack *middleware.Stack) error

AddRecursionDetection adds recursionDetection to the middleware stack



15
16
17
 
// File 'aws/middleware/recursion_detection.go', line 15


func AddRecursionDetection(stack *middleware.Stack) error {
	return stack.Build.Add(&RecursionDetection{}, middleware.After)
}

func AddRequestIDRetrieverMiddleware(stack *middleware.Stack) error

AddRequestIDRetrieverMiddleware adds request id retriever middleware



11
12
13
14
15
 
// File 'aws/middleware/request_id_retriever.go', line 11


func AddRequestIDRetrieverMiddleware(stack *middleware.Stack) error {
	// add error wrapper middleware before operation deserializers so that it can wrap the error response
	// returned by operation deserializers
	return stack.Deserialize.Insert(&RequestIDRetriever{}, "OperationDeserializer", middleware.Before)
}

func AddRequestUserAgentMiddleware(stack *middleware.Stack) error

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



262
263
264
265
 
// File 'aws/middleware/user_agent.go', line 262


func AddRequestUserAgentMiddleware(stack *middleware.Stack) error {
	_, err := getOrAddRequestUserAgent(stack)
	return err
}

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

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



238
239
240
241
242
243
244
245
246
247
 
// File 'aws/middleware/user_agent.go', line 238


func AddSDKAgentKey(keyType SDKAgentKeyType, key string) func(*middleware.Stack) error {
	return func(stack *middleware.Stack) error {
		requestUserAgent, err := getOrAddRequestUserAgent(stack)
		if err != nil {
			return err
		}
		requestUserAgent.AddSDKAgentKey(keyType, key)
		return nil
	}
}

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

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



250
251
252
253
254
255
256
257
258
259
 
// File 'aws/middleware/user_agent.go', line 250


func AddSDKAgentKeyValue(keyType SDKAgentKeyType, key, value string) func(*middleware.Stack) error {
	return func(stack *middleware.Stack) error {
		requestUserAgent, err := getOrAddRequestUserAgent(stack)
		if err != nil {
			return err
		}
		requestUserAgent.AddSDKAgentKeyValue(keyType, key, value)
		return nil
	}
}

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

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



214
215
216
217
218
219
220
221
222
223
 
// File 'aws/middleware/user_agent.go', line 214


func AddUserAgentKey(key string) func(*middleware.Stack) error {
	return func(stack *middleware.Stack) error {
		requestUserAgent, err := getOrAddRequestUserAgent(stack)
		if err != nil {
			return err
		}
		requestUserAgent.AddUserAgentKey(key)
		return nil
	}
}

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

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



226
227
228
229
230
231
232
233
234
235
 
// File 'aws/middleware/user_agent.go', line 226


func AddUserAgentKeyValue(key, value string) func(*middleware.Stack) error {
	return func(stack *middleware.Stack) error {
		requestUserAgent, err := getOrAddRequestUserAgent(stack)
		if err != nil {
			return err
		}
		requestUserAgent.AddUserAgentKeyValue(key, value)
		return nil
	}
}

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

GetAttemptSkew returns Attempt clock skew for response from metadata.



116
117
118
119
 
// File 'aws/middleware/middleware.go', line 116


func GetAttemptSkew(metadata middleware.Metadata) (v time.Duration, ok bool) {
	v, ok = metadata.Get(attemptSkewKey{}).(time.Duration)
	return v, ok
}

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

GetEndpointSource returns an endpoint source if set on context



191
192
193
194
 
// File 'aws/middleware/metadata.go', line 191


func GetEndpointSource(ctx context.Context) (v aws.EndpointSource) {
	v, _ = middleware.GetStackValue(ctx, endpointSourceKey{}).(aws.EndpointSource)
	return v
}

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.



100
101
102
103
 
// File 'aws/middleware/metadata.go', line 100


func GetOperationName(ctx context.Context) (v string) {
	v, _ = middleware.GetStackValue(ctx, operationNameKey{}).(string)
	return v
}

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.



109
110
111
112
 
// File 'aws/middleware/metadata.go', line 109


func GetPartitionID(ctx context.Context) string {
	v, _ := middleware.GetStackValue(ctx, partitionIDKey{}).(string)
	return v
}

func GetRawResponse(metadata middleware.Metadata) interface{}

GetRawResponse returns raw response set on metadata



165
166
167
 
// File 'aws/middleware/middleware.go', line 165


func GetRawResponse(metadata middleware.Metadata) interface{} {
	return metadata.Get(rawResponseKey{})
}

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.



91
92
93
94
 
// File 'aws/middleware/metadata.go', line 91


func GetRegion(ctx context.Context) (v string) {
	v, _ = middleware.GetStackValue(ctx, regionKey{}).(string)
	return v
}

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.



16
17
18
19
20
21
22
23
24
25
26
 
// File 'aws/middleware/request_id.go', line 16


func GetRequestIDMetadata(metadata middleware.Metadata) (string, bool) {
	if !metadata.Has(requestIDKey{}) {
		return "", false
	}

	v, ok := metadata.Get(requestIDKey{}).(string)
	if !ok {
		return "", true
	}
	return v, true
}

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.



119
120
121
122
 
// File 'aws/middleware/metadata.go', line 119


func GetRequiresLegacyEndpoints(ctx context.Context) bool {
	v, _ := middleware.GetStackValue(ctx, requiresLegacyEndpointsKey{}).(bool)
	return v
}

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

GetResponseAt returns the time response was received at.



90
91
92
93
 
// File 'aws/middleware/middleware.go', line 90


func GetResponseAt(metadata middleware.Metadata) (v time.Time, ok bool) {
	v, ok = metadata.Get(responseAtKey{}).(time.Time)
	return v, ok
}

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

GetServerTime returns the server time for response.



103
104
105
106
 
// File 'aws/middleware/middleware.go', line 103


func GetServerTime(metadata middleware.Metadata) (v time.Time, ok bool) {
	v, ok = metadata.Get(serverTimeKey{}).(time.Time)
	return v, ok
}

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.



58
59
60
61
 
// File 'aws/middleware/metadata.go', line 58


func GetServiceID(ctx context.Context) (v string) {
	v, _ = middleware.GetStackValue(ctx, serviceIDKey{}).(string)
	return v
}

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

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



204
205
206
207
 
// File 'aws/middleware/metadata.go', line 204


func GetSigningCredentials(ctx context.Context) (v aws.Credentials) {
	v, _ = middleware.GetStackValue(ctx, signingCredentialsKey{}).(aws.Credentials)
	return v
}

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.



70
71
72
73
 
// File 'aws/middleware/metadata.go', line 70


func GetSigningName(ctx context.Context) (v string) {
	v, _ = middleware.GetStackValue(ctx, signingNameKey{}).(string)
	return v
}

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.



82
83
84
85
 
// File 'aws/middleware/metadata.go', line 82


func GetSigningRegion(ctx context.Context) (v string) {
	v, _ = middleware.GetStackValue(ctx, signingRegionKey{}).(string)
	return v
}

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

SetEndpointSource sets endpoint source on context



197
198
199
 
// File 'aws/middleware/metadata.go', line 197


func SetEndpointSource(ctx context.Context, value aws.EndpointSource) context.Context {
	return middleware.WithStackValue(ctx, endpointSourceKey{}, value)
}

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.



183
184
185
 
// File 'aws/middleware/metadata.go', line 183


func SetPartitionID(ctx context.Context, value string) context.Context {
	return middleware.WithStackValue(ctx, partitionIDKey{}, value)
}

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

SetRequestIDMetadata sets the provided request id over middleware metadata



10
11
12
 
// File 'aws/middleware/request_id.go', line 10


func SetRequestIDMetadata(metadata *middleware.Metadata, id string) {
	metadata.Set(requestIDKey{}, id)
}

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.



129
130
131
 
// File 'aws/middleware/metadata.go', line 129


func SetRequiresLegacyEndpoints(ctx context.Context, value bool) context.Context {
	return middleware.WithStackValue(ctx, requiresLegacyEndpointsKey{}, value)
}

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.



159
160
161
 
// File 'aws/middleware/metadata.go', line 159


func SetServiceID(ctx context.Context, value string) context.Context {
	return middleware.WithStackValue(ctx, serviceIDKey{}, value)
}

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

SetSigningCredentials sets the credentails used for signing on the context.



210
211
212
 
// File 'aws/middleware/metadata.go', line 210


func SetSigningCredentials(ctx context.Context, value aws.Credentials) context.Context {
	return middleware.WithStackValue(ctx, signingCredentialsKey{}, value)
}

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.



140
141
142
 
// File 'aws/middleware/metadata.go', line 140


func SetSigningName(ctx context.Context, value string) context.Context {
	return middleware.WithStackValue(ctx, signingNameKey{}, value)
}

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.



151
152
153
 
// File 'aws/middleware/metadata.go', line 151


func SetSigningRegion(ctx context.Context, value string) context.Context {
	return middleware.WithStackValue(ctx, signingRegionKey{}, value)
}