fix: Improve AWS credentials error message and local profile docs (#4708)

erezrokah · web-flow · commit 2a159b83528a · 2022-11-16T09:37:58.000Z
#### Summary Fixes #4656 <!--
diff --git a/plugins/source/aws/client/client.go b/plugins/source/aws/client/client.go
@@ -321,7 +321,7 @@ func configureAwsClient(ctx context.Context, logger zerolog.Logger, awsConfig *S
 	// Test out retrieving credentials
 	if _, err := awsCfg.Credentials.Retrieve(ctx); err != nil {
 		logger.Error().Err(err).Msg("error retrieving credentials")
-		return awsCfg, fmt.Errorf("error retrieving credentials: %w", err)
+		return awsCfg, fmt.Errorf("error retrieving AWS credentials (see logs for details). Please verify your credentials and try again")
 	}
 
 	return awsCfg, err
diff --git a/plugins/source/aws/docs/configuration.md b/plugins/source/aws/docs/configuration.md
@@ -53,7 +53,20 @@ This is used to specify one or more accounts to extract information from. Note t
 
 - `local_profile` (string) (default: will use current credentials)
 
-  [Local profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) to use to authenticate this account with
+  [Local profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) to use to authenticate this account with.
+  Please note this should be set to the name of the profile. For example, with the following credentials file:
+
+  ```ini
+  [default]
+  aws_access_key_id=xxxx
+  aws_secret_access_key=xxxx
+
+  [user1]
+  aws_access_key_id=xxxx
+  aws_secret_access_key=xxxx
+  ```
+
+  `local_profile` should be set to either `default` or `user1`.
 
 - `role_arn` (string)
 

Original file line number	Diff line number	Diff line change
`@@ -321,7 +321,7 @@ func configureAwsClient(ctx context.Context, logger zerolog.Logger, awsConfig *S`
`321`	`321`	`// Test out retrieving credentials`
`322`	`322`	`if _, err := awsCfg.Credentials.Retrieve(ctx); err != nil {`
`323`	`323`	`logger.Error().Err(err).Msg("error retrieving credentials")`
`324`		`- return awsCfg, fmt.Errorf("error retrieving credentials: %w", err)`
	`324`	`+ return awsCfg, fmt.Errorf("error retrieving AWS credentials (see logs for details). Please verify your credentials and try again")`
`325`	`325`	`}`
`326`	`326`
`327`	`327`	`return awsCfg, err`