aws-amplify / aws-amplify/docs
Clarify amplify-admin local AWS setup profile
- Dominant language
- MDX
- Stars
- 506
- Forks
- 1.1k
- Avg merge
- 3h 14m
- Merged PRs (30d)
- 1
Description
**Describe the content issue**:
Currently the amplify-admin local AWS setup profile documentation (step 4) includes the following CLI session:
```bash
CLI profile name [amplify-policy-]: default
To use this profile, specify the profile name using --profile, as shown:
aws s3 ls --profile default
```
When I ran the suggested command, I got an error:
```bash
$ aws s3 ls --profile default
An error occurred (AccessDenied) when calling the ListBuckets operation: Access Denied
```
I suspected something went wrong during the previous steps, but after troubleshooting I discovered that the role associated with the profile intentionally lacks permissions to list S3 buckets, and that this is expected. To prevent others from spending time troubleshooting this, I suggest that a note be added after the output `aws s3 ls --profile default` clarifying that running that generic example command will fail because the amplify admin user's least privilege role intentionally does not include this permission, and that you should proceed to the next step to verify your amplify setup.
**URL page where content issue is**: https://docs.amplify.aws/vue/start/account-setup/#4-set-up-local-aws-profile
Contributor guide
Research direction
Open the linked Amplify account-setup page and go to “4. Set up local AWS profile,” where the CLI session includes `aws s3 ls --profile default`. Add a note explaining that AccessDenied is expected because the least-privilege role cannot list S3 buckets, and that users should continue to the next setup step.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100