Update processcreds.CredentialProcessResponse visibility to public
#1921
Conversation
There was a problem hiding this comment.
For context - I am authoring a custom tool for use as a credential_process, which requires a type that I can instantiate and json.Marshal to stdout.
I am currently duplicating this type, but referencing a canonical type from the package (which is also handling AWS profile manipulation) would be the semantically correct thing, and would avoid inadvertent tool breakages when e.g. upgrading the SDK version.
For consistency, and identical change was made in aws/aws-sdk-go#4621.
Thank you for your consideration!
| // A CredentialProcessResponse is the AWS credentials format that must be | ||
| // returned when executing an external credential_process. | ||
| type CredentialProcessResponse struct { | ||
| // As of this writing, the Version key must be set to 1. This might |
There was a problem hiding this comment.
Comment taken from AWS CLI credential_process authoring documentation.
| // increment over time as the structure evolves. | ||
| Version int | ||
|
|
||
| // The access key ID that identifies the temporary security credentials. |
There was a problem hiding this comment.
Comments copied from the types.Credentials struct fields.
See https://github.com/aws/aws-sdk-go-v2/blob/main/service/sts/types/types.go#L34.
|
Friendly 1-week ping if anyone would like to approve the CI workflows 🙂 |
|
Friendly 1-month ping for some engagement 🙂 |
|
Thanks for the PR and sorry for the delay. I think I agree that this is effectively part of the overall ecosystem tooling interface. Making this type public should be ok. It looks like CI checks didn't run yet, can you try and push up an empty commit to see if it triggers an approval? Thanks. |
In order to have a canonical type for encoding/decoding JSON for a credential process, the visibility of this type needed to be public. This type has been detailed in official AWS CLI documentation and is effectively part of the tooling ecosystem's external interface.
|
Thank you so much @aajtodd! I rebased off of the latest |
In order to have a canonical type for encoding/decoding JSON for a credential process, the visibility of this type needed to be public. This type has been detailed in official AWS CLI documentation and is effectively part of the tooling ecosystem's external interface.