Add support for accessing and updating FrameworkMetadata at runtime

[phantumcode]

Describe the feature

Currently the Amplify Swift library uses the FrameworkMetadata to configure the framework name and version. This metadata is used to populate the UserAgent filed in the service client requests.

The FrameworkMetadata is configured at client configuration time, but is needed to be updatable at runtime.

Use Case

The Amplify Swift library has requirements to capture additional metatadata that are dynamic at runtime such as framework api signature and environment locale and region.

Proposed Solution

Change the FrameworkMetadata extra field to be accessible and editable at runtime per request

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

[ganeshnj]

we have a consistent way to extend user agent using https://github.com/awslabs/aws-sdk-swift/blob/main/Sources/Core/AWSClientRuntime/Http/ExecutionEnvMetadata.swift#LL23C65-L23C82 env var

I wonder what's the use case here. Adding anything extra to the env var will be get injected to user agent.

[phantumcode]

@ganeshnj Thanks for pointing out ExecutionEnvMetadata.

The use case fromthe Amplify Swift library is to be able to identify which of the Amplify api is being called from the customer.

For example, if a customer app is using Amplify library for the storage category and calls the api Amplify.Storage.uploadData(key:, data:, options:), we would like to include the api signature in the UserAgent for all api usages going through Amplify.

The UserAgent would look something like:
User-Agent: aws-sdk-swift/1.0 api/xx-xx-xx/1.0 os/iOS/16.2.0 lang/swift/5.7 lib/amplify-ios/2.2.0/amplify.storage.upload(key:, data:, options)

It doesn't look like ExecutionEnvMetadata would support this use case. We would need to this set this for each api execution at runtime.