READMEs

awsdocs · Apr 1, 2024 · 2a96b36 · 2a96b36
1 parent 57b498a
commit 2a96b36
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 45 deletions.
diff --git a/javav2/example_code/ses/Readme.md b/javav2/example_code/ses/Readme.md
@@ -1,20 +1,20 @@
-# Amazon SES v2 API code examples for the SDK for Java 2.x
+# Amazon SES code examples for the SDK for Java 2.x
 
 ## Overview
 
-Shows how to use the AWS SDK for Java 2.x to work with Amazon Simple Email Service v2 API.
+Shows how to use the AWS SDK for Java 2.x to work with Amazon Simple Email Service (Amazon SES).
 
 <!--custom.overview.start-->
 <!--custom.overview.end-->
 
-_Amazon SES v2 API is a reliable, scalable, and cost-effective email service._
+_Amazon SES is a reliable, scalable, and cost-effective email service._
 
 ## ⚠ Important
 
-- Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
-- Running the tests might result in charges to your AWS account.
-- We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
-- This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
+* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
+* Running the tests might result in charges to your AWS account.
+* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
+* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
 
 <!--custom.important.start-->
 <!--custom.important.end-->
@@ -25,23 +25,19 @@ _Amazon SES v2 API is a reliable, scalable, and cost-effective email service._
 
 For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav2` folder.
 
+
 <!--custom.prerequisites.start-->
 <!--custom.prerequisites.end-->
 
 ### Single actions
 
 Code excerpts that show you how to call individual service functions.
 
-- [Create a contact in a contact list](src/main/java/com/example/sesv2/NewsletterWorkflow.java#L199) (`CreateContact`)
-- [Create a contact list](src/main/java/com/example/sesv2/NewsletterWorkflow.java#L113) (`CreateContactList`)
-- [Create an email identity](src/main/java/com/example/sesv2/NewsletterWorkflow.java#L91) (`CreateEmailIdentity`)
-- [Create an email template](src/main/java/com/example/sesv2/NewsletterWorkflow.java#L133) (`CreateEmailTemplate`)
-- [Delete a contact list](src/main/java/com/example/sesv2/NewsletterWorkflow.java#L325) (`DeleteContactList`)
-- [Delete an email identity](src/main/java/com/example/sesv2/NewsletterWorkflow.java#L369) (`DeleteEmailIdentity`)
-- [Delete an email template](src/main/java/com/example/sesv2/NewsletterWorkflow.java#L344) (`DeleteEmailTemplate`)
-- [List the contacts in a contact list](src/main/java/com/example/sesv2/NewsletterWorkflow.java#L252) (`ListContacts`)
-- [Send a simple email](src/main/java/com/example/sesv2/SendEmail.java#L6) (`SendEmail`)
-- [Send a templated email](src/main/java/com/example/sesv2/NewsletterWorkflow.java#L263) (`SendEmail`)
+- [List email templates](src/main/java/com/example/sesv2/ListTemplates.java#L6) (`ListTemplates`)
+- [List identities](src/main/java/com/example/ses/ListIdentities.java#L6) (`ListIdentities`)
+- [Send email](src/main/java/com/example/ses/SendMessageEmailRequest.java#L6) (`SendEmail`)
+- [Send templated email](src/main/java/com/example/sesv2/SendEmailTemplate.java#L6) (`SendTemplatedEmail`)
+
 
 <!--custom.examples.start-->
 <!--custom.examples.end-->
@@ -50,6 +46,7 @@ Code excerpts that show you how to call individual service functions.
 
 ### Instructions
 
+
 <!--custom.instructions.start-->
 
 #### SESv2 Newsletter Workflow
@@ -60,21 +57,26 @@ To run the Newsletter example, copy the files from workflows/sesv2_weekly_mailer
 
 <!--custom.instructions.end-->
 
+
+
 ### Tests
 
 ⚠ Running tests might result in charges to your AWS account.
 
+
 To find instructions for running these tests, see the [README](../../README.md#Tests)
 in the `javav2` folder.
 
+
+
 <!--custom.tests.start-->
 <!--custom.tests.end-->
 
 ## Additional resources
 
-- [Amazon SES v2 API Developer Guide](https://docs.aws.amazon.com/ses/latest/dg/Welcome.html)
-- [Amazon SES v2 API API Reference](https://docs.aws.amazon.com/ses/latest/APIReference-V2/Welcome.html)
-- [SDK for Java 2.x Amazon SES v2 API reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/ses/package-summary.html)
+- [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 Java 2.x Amazon SES reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/ses/package-summary.html)
 
 <!--custom.resources.start-->
 <!--custom.resources.end-->
@@ -83,4 +85,4 @@ in the `javav2` folder.
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
-SPDX-License-Identifier: Apache-2.0
+SPDX-License-Identifier: Apache-2.0
diff --git a/python/example_code/sesv2/README.md b/python/example_code/sesv2/README.md
@@ -11,10 +11,10 @@ _Amazon SES v2 API is a reliable, scalable, and cost-effective email service._
 
 ## ⚠ Important
 
-- Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
-- Running the tests might result in charges to your AWS account.
-- We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
-- This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
+* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
+* Running the tests might result in charges to your AWS account.
+* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
+* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
 
 <!--custom.important.start-->
 <!--custom.important.end-->
@@ -38,16 +38,17 @@ python -m pip install -r requirements.txt
 
 Code excerpts that show you how to call individual service functions.
 
-- [Create a contact in a contact list](newsletter.py#L149) (`CreateContact`)
-- [Create a contact list](newsletter.py#L99) (`CreateContactList`)
-- [Create an email identity](newsletter.py#L86) (`CreateEmailIdentity`)
-- [Create an email template](newsletter.py#L112) (`CreateEmailTemplate`)
-- [Delete a contact list](newsletter.py#L250) (`DeleteContactList`)
-- [Delete an email identity](newsletter.py#L278) (`DeleteEmailIdentity`)
-- [Delete an email template](newsletter.py#L263) (`DeleteEmailTemplate`)
-- [List the contacts in a contact list](newsletter.py#L192) (`ListContacts`)
-- [Send a simple email](newsletter.py#L158) (`SendEmail`)
-- [Send a templated email](newsletter.py#L211) (`SendEmail`)
+- [Create a contact in a contact list](newsletter.py#L152) (`CreateContact`)
+- [Create a contact list](newsletter.py#L102) (`CreateContactList`)
+- [Create an email identity](newsletter.py#L89) (`CreateEmailIdentity`)
+- [Create an email template](newsletter.py#L115) (`CreateEmailTemplate`)
+- [Delete a  contact list](newsletter.py#L255) (`DeleteContactList`)
+- [Delete an email identity](newsletter.py#L283) (`DeleteEmailIdentity`)
+- [Delete an email template](newsletter.py#L268) (`DeleteEmailTemplate`)
+- [List the contacts in a contact list](newsletter.py#L195) (`ListContacts`)
+- [Send a simple email](newsletter.py#L161) (`SendEmail`)
+- [Send a templated email](newsletter.py#L214) (`SendEmail`)
+
 
 <!--custom.examples.start-->
 <!--custom.examples.end-->
@@ -56,6 +57,7 @@ Code excerpts that show you how to call individual service functions.
 
 ### Instructions
 
+
 <!--custom.instructions.start-->
 
 #### SESv2 Newsletter Workflow
@@ -66,13 +68,18 @@ To run the Newsletter example, copy the files from workflows/sesv2_weekly_mailer
 
 <!--custom.instructions.end-->
 
+
+
 ### Tests
 
 ⚠ Running tests might result in charges to your AWS account.
 
+
 To find instructions for running these tests, see the [README](../../README.md#Tests)
 in the `python` folder.
 
+
+
 <!--custom.tests.start-->
 <!--custom.tests.end-->
 
@@ -89,4 +96,4 @@ in the `python` folder.
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
-SPDX-License-Identifier: Apache-2.0
+SPDX-License-Identifier: Apache-2.0
diff --git a/rustv1/examples/ses/README.md b/rustv1/examples/ses/README.md
@@ -11,10 +11,10 @@ _Amazon SES v2 API is a reliable, scalable, and cost-effective email service._
 
 ## ⚠ Important
 
-- Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
-- Running the tests might result in charges to your AWS account.
-- We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
-- This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
+* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
+* Running the tests might result in charges to your AWS account.
+* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
+* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
 
 <!--custom.important.start-->
 <!--custom.important.end-->
@@ -25,6 +25,7 @@ _Amazon SES v2 API is a reliable, scalable, and cost-effective email service._
 
 For prerequisites, see the [README](../../README.md#Prerequisites) in the `rustv1` folder.
 
+
 <!--custom.prerequisites.start-->
 <!--custom.prerequisites.end-->
 
@@ -36,14 +37,15 @@ Code excerpts that show you how to call individual service functions.
 - [Create a contact list](src/bin/create-contact-list.rs#L26) (`CreateContactList`)
 - [Create an email identity](src/newsletter.rs#L49) (`CreateEmailIdentity`)
 - [Create an email template](src/newsletter.rs#L94) (`CreateEmailTemplate`)
-- [Delete a contact list](src/newsletter.rs#L338) (`DeleteContactList`)
-- [Delete an email identity](src/newsletter.rs#L376) (`DeleteEmailIdentity`)
-- [Delete an email template](src/newsletter.rs#L351) (`DeleteEmailTemplate`)
+- [Delete a  contact list](src/newsletter.rs#L345) (`DeleteContactList`)
+- [Delete an email identity](src/newsletter.rs#L383) (`DeleteEmailIdentity`)
+- [Delete an email template](src/newsletter.rs#L358) (`DeleteEmailTemplate`)
 - [Get identity information](src/bin/is-email-verified.rs#L26) (`GetEmailIdentity`)
 - [List the contact lists](src/bin/list-contact-lists.rs#L22) (`ListContactLists`)
 - [List the contacts in a contact list](src/bin/list-contacts.rs#L26) (`ListContacts`)
 - [Send a simple email](src/bin/send-email.rs#L39) (`SendEmail`)
-- [Send a templated email](src/newsletter.rs#L255) (`SendEmail`)
+- [Send a templated email](src/newsletter.rs#L261) (`SendEmail`)
+
 
 <!--custom.examples.start-->
 <!--custom.examples.end-->
@@ -52,6 +54,7 @@ Code excerpts that show you how to call individual service functions.
 
 ### Instructions
 
+
 <!--custom.instructions.start-->
 
 #### SESv2 Newsletter Workflow
@@ -62,13 +65,18 @@ To run the Newsletter example, copy the files from workflows/sesv2_weekly_mailer
 
 <!--custom.instructions.end-->
 
+
+
 ### Tests
 
 ⚠ Running tests might result in charges to your AWS account.
 
+
 To find instructions for running these tests, see the [README](../../README.md#Tests)
 in the `rustv1` folder.
 
+
+
 <!--custom.tests.start-->
 <!--custom.tests.end-->
 
@@ -85,4 +93,4 @@ in the `rustv1` folder.
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
-SPDX-License-Identifier: Apache-2.0
+SPDX-License-Identifier: Apache-2.0