javav2/example_code/{service}/
├── README.md                   # Generated service README
├── pom.xml                     # Maven dependencies
└── {service}_metadata.yaml     # Metadata (in .doc_gen/metadata/)

cd .tools/readmes

# Create virtual environment
python -m venv .venv

# Activate environment (Linux/macOS)
source .venv/bin/activate

# Activate environment (Windows)
.venv\Scripts\activate

# Install dependencies
python -m pip install -r requirements_freeze.txt

# Generate README for specific service
python -m writeme --languages Java:2 --services {service}

# {AWS Service} code examples for the SDK for Java 2.x

## Overview

This is a workspace where you can find the following AWS SDK for Java 2.x 
{AWS Service} examples.

## ⚠ Important

* Running this code might result in charges to your AWS account.
* Running the tests might result in charges to your AWS account.
* We recommend that you grant your code least privilege.

## Code examples

### Actions

The following examples show you how to perform actions using the AWS SDK for Java 2.x.

* [Create a resource](src/main/java/com/example/{service}/{Service}Actions.java#L123) (`CreateResource`)
* [Get a resource](src/main/java/com/example/{service}/{Service}Actions.java#L456) (`GetResource`)

### Scenarios

The following examples show you how to implement common scenarios.

* [Get started with resources](src/main/java/com/example/{service}/{Service}Scenario.java) - Learn the basics by creating and managing resources.

### Hello

* [Hello {Service}](src/main/java/com/example/{service}/Hello{Service}.java) - Get started with {AWS Service}.

## Prerequisites

- You must have an AWS account, and have your default credentials and AWS Region configured.
- Java 17 or later
- Maven 3.6 or later

## Install

To build and run the examples, navigate to the directory that contains a `pom.xml` file and run the following command:

## Run the examples

### Instructions

All examples can be run individually. For example:

### Hello {Service}

This example shows you how to get started using {AWS Service}.

### Get started with {Service} resources

This interactive scenario runs at a command prompt and shows you how to use {AWS Service} to do the following:

1. Create a resource
2. Use the resource  
3. Clean up resources

## Run the tests

Unit tests in this module use JUnit 5. To run all of the tests, 
run the following in your [GitHub root]/javav2/example_code/{service} folder.

## Additional resources

- [{AWS Service} User Guide](https://docs.aws.amazon.com/{service}/latest/ug/)
- [{AWS Service} API Reference](https://docs.aws.amazon.com/{service}/latest/APIReference/)
- [AWS SDK for Java 2.x ({AWS Service})](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/{service}/package-summary.html)

# Check for metadata errors
python -m writeme --languages Java:2 --services {service} --verbose

# Validate specific metadata file
python -c "import yaml; yaml.safe_load(open('.doc_gen/metadata/{service}_metadata.yaml'))"

# Check for missing snippet tags
grep -r "snippet-start" javav2/example_code/{service}/

# In CI/CD pipeline, validate README is up-to-date
cd .tools/readmes
source .venv/bin/activate
python -m writeme --languages Java:2 --services {service} --check

# Exit with error if README needs updates
if git diff --exit-code javav2/example_code/{service}/README.md; then
    echo "README is up-to-date"
else
    echo "README needs to be regenerated"
    exit 1
fi

<!-- In pom.xml -->
<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>exec-maven-plugin</artifactId>
    <version>3.1.0</version>
    <executions>
        <execution>
            <id>generate-readme</id>
            <phase>validate</phase>
            <goals>
                <goal>exec</goal>
            </goals>
            <configuration>
                <executable>python</executable>
                <workingDirectory>.tools/readmes</workingDirectory>
                <arguments>
                    <argument>-m</argument>
                    <argument>writeme</argument>
                    <argument>--languages</argument>
                    <argument>Java:2</argument>
                    <argument>--services</argument>
                    <argument>{service}</argument>
                </arguments>
            </configuration>
        </execution>
    </executions>
</plugin>