Skip to content

[Enhancement]: Revise comment at top of examples #6304

Open
@tkhill-AWS

Description

@tkhill-AWS

Background story

The entry point for some people are the examples when they start using Java with AWS.
They appear to go to examples before setting up authentication and/or their environment to use AWS services with Java.

To help mitigate the number of bounces between sites to get things set up, provide users with more information that they need to be ensure they can run the example--authentication and/or general setup.

Replace this (which is currently found at the top of the JavaV2 files):

/**

with this (auth and/or setup links):

Before running this example:

What does this example accomplish?

NA

Which AWS service(s)?

All.

Which AWS SDKs or tools?

  • All languages
  • .NET
  • C++
  • Go (v2)
  • Java
  • Java (v2)
  • JavaScript
  • JavaScript (v3)
  • Kotlin
  • PHP
  • Python
  • Ruby
  • Rust
  • Swift
  • Not applicable

Are there existing code examples to leverage?

No response

Do you have any reference code?

Scott and I discussed this in our weekly one-on-one.

Metadata

Metadata

Assignees

Labels

TaskA general update to the code base for language clarification, missing actions, tests, etc.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions