Skip to content
This repository was archived by the owner on Jul 31, 2025. It is now read-only.

Commit 9e96944

Browse files
authored
Merge pull request #3341 from diehlaws/docs/credentials
aws/credentials: Update shared creds provider docs
2 parents 329ee86 + 13975b1 commit 9e96944

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CHANGELOG_PENDING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
### SDK Features
22

33
### SDK Enhancements
4+
* `aws/credentials`: Update documentation for shared credentials provider to specify the type of credentials it supports retrieving from shared credentials file.
5+
* Related to [#3328](https://github.com/aws/aws-sdk-go/issues/3328)
46

57
### SDK Bugs

aws/credentials/shared_credentials_provider.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ var (
1717
ErrSharedCredentialsHomeNotFound = awserr.New("UserHomeNotFound", "user home directory not found.", nil)
1818
)
1919

20-
// A SharedCredentialsProvider retrieves credentials from the current user's home
21-
// directory, and keeps track if those credentials are expired.
20+
// A SharedCredentialsProvider retrieves access key pair (access key ID,
21+
// secret access key, and session token if present) credentials from the current
22+
// user's home directory, and keeps track if those credentials are expired.
2223
//
2324
// Profile ini file example: $HOME/.aws/credentials
2425
type SharedCredentialsProvider struct {

0 commit comments

Comments
 (0)