[
https://issues.apache.org/jira/browse/BEAM-3986?focusedWorklogId=96737&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-96737
]
ASF GitHub Bot logged work on BEAM-3986:
----------------------------------------
Author: ASF GitHub Bot
Created on: 30/Apr/18 15:52
Start Date: 30/Apr/18 15:52
Worklog Time Spent: 10m
Work Description: pgerv12 opened a new pull request #5248: [BEAM-3986]
Enhance awsCredentialsProvider option description
URL: https://github.com/apache/beam/pull/5248
Improves `--awsCredentialsProvider` description and javadoc by including
required field `@type` and providing an example since previously there was no
indication that the field was required.
------------------------
Follow this checklist to help us incorporate your contribution quickly and
easily:
- [x] Make sure there is a [JIRA
issue](https://issues.apache.org/jira/projects/BEAM/issues/) filed for the
change (usually before you start working on it). Trivial changes like typos do
not require a JIRA issue. Your pull request should address just this issue,
without pulling in other changes.
- [x] Format the pull request title like `[BEAM-XXX] Fixes bug in
ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA
issue.
- [ ] Write a pull request description that is detailed enough to
understand:
- [ ] What the pull request does
- [ ] Why it does it
- [ ] How it does it
- [ ] Why this approach
- [ ] Each commit in the pull request should have a meaningful subject line
and body.
- [ ] Run `./gradlew build` to make sure basic checks pass. A more thorough
check will be performed on your pull request automatically.
- [ ] If this contribution is large, please file an Apache [Individual
Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 96737)
Time Spent: 10m
Remaining Estimate: 0h
> Improve setAwsCredentialsProvider documentation
> -----------------------------------------------
>
> Key: BEAM-3986
> URL: https://issues.apache.org/jira/browse/BEAM-3986
> Project: Beam
> Issue Type: Improvement
> Components: io-java-aws
> Affects Versions: 2.4.0
> Reporter: Paul Gerver
> Assignee: Paul Gerver
> Priority: Trivial
> Time Spent: 10m
> Remaining Estimate: 0h
>
> I tried using --awsCredentialsProvider with a JSON string (i.e.,
> --awsCredentialsProvider='\{"awsAccessKeyId" : "<keyid>", "awsSecretKey" :
> "<secret>"}') and it was not clear from documentation that "@type" and an AWS
> credentials class was required.
> We should improve the javadoc and PipelineOptions to include the following
> description/example:
> @Description("The credential instance that should be used to authenticate
> against AWS services. " + "The option value must contain \"@type\" field and
> an AWS Credentials Provider class name as a value. " + "Refer to
> DefaultAWSCredentialsProviderChain Javadoc for usage help. " + "For example,
> to specify the AWS key ID and secret on the command line, specify the
> following: \{\"@type\": \"AWSStaticCredentialsProvider\",
> \"awsAccessKeyId\":\"<key_id>\", \"awsSecretKey\":\"<secret_key>\"}
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
