Skip to content

Commit

Permalink
updates for review.
Browse files Browse the repository at this point in the history
  • Loading branch information
meyertst-aws committed Nov 1, 2023
1 parent 3bf43dd commit bd79f5f
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .tools/readmes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ authored for the SOS project. After you have authored metadata and snippet tags
for your examples, run the following command in the root folder of the repo:

```
python .doc_gen/readmes/writeme.py <language> <version> <service>
python .tools/readmes/writeme.py <language> <version> <service>
```

WRITME reads metadata and config data and generates a README in the service
Expand Down
12 changes: 12 additions & 0 deletions .tools/readmes/includes/run_instructions.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,18 @@ dotnet run

Alternatively, you can run the example from within your IDE.

{% endif %}

{% if lang_config['name'] == 'C++' %}
An executable is built for each source file. These executables are located in the build folder and have
"run_" prepended to the source file name, minus the suffix. See the "main" function in the source file for further instructions.

For example, to run the action in the source file "my_action.cpp", execute the following command from within the build folder. The command
will display any required arguments.

```
./run_my_action
```
{% endif %}
<!--custom.instructions.start-->
{{ customs['instructions'] -}}
Expand Down
16 changes: 13 additions & 3 deletions cpp/example_code/ses/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--Generated by WRITEME on 2023-10-30 18:18:01.349521 (UTC)-->
<!--Generated by WRITEME on 2023-11-01 14:39:38.911259 (UTC)-->
# Amazon SES code examples for the SDK for C++

## Overview
Expand Down Expand Up @@ -53,7 +53,7 @@ Code excerpts that show you how to call individual service functions.
* [Delete an identity](delete_identity.cpp#L23) (`DeleteIdentity`)
* [Get an existing email template](get_template.cpp#L24) (`GetTemplate`)
* [List identities](list_identities.cpp#L23) (`ListIdentities`)
* [List receipt filters](list_receipt_filters.cpp#L25) (`ListReceiptFilters`)
* [List receipt filters](list_receipt_filters.cpp#L24) (`ListReceiptFilters`)
* [Send email](send_email.cpp#L28) (`SendEmail`)
* [Send templated email](send_templated_email.cpp#L25) (`SendTemplatedEmail`)
* [Update an email template](update_template.cpp#L24) (`UpdateTemplate`)
Expand All @@ -70,6 +70,16 @@ Sample applications that work across multiple AWS services.
### Instructions



An executable is built for each source file. These executables are located in the build folder and have
"run_" prepended to the source file name, minus the suffix. See the "main" function in the source file for further instructions.

For example, to run the action in the source file "my_action.cpp", execute the following command from within the build folder. The command
will display any required arguments.

```
./run_my_action
```
<!--custom.instructions.start-->
<!--custom.instructions.end-->

Expand All @@ -96,7 +106,7 @@ Sample applications that work across multiple AWS services.

* [Amazon SES Developer Guide](https://docs.aws.amazon.com/ses/latest/dg/Welcome.html)
* [Amazon SES API Reference](https://docs.aws.amazon.com/ses/latest/APIReference/Welcome.html)
* [SDK for C++ Amazon SES reference](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-ses/html/annotated.html)
* [SDK for C++ Amazon SES reference](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-email/html/annotated.html)

<!--custom.resources.start-->
<!--custom.resources.end-->
Expand Down

0 comments on commit bd79f5f

Please sign in to comment.