Update README.md

Author: rlhagerm

dotnetv4/Redshift/README.md

@@ -1,129 +1,119 @@
-# Amazon Redshift code examples for the SDK for .NET Framework 4.x
+# Amazon Redshift code examples for the SDK for .NET (v4)
 
 ## Overview
 
-This folder contains code examples that demonstrate how to use the AWS SDK for .NET Framework 4.x to interact with Amazon Redshift.
+Shows how to use the AWS SDK for .NET (v4) to work with Amazon Redshift.
 
-Amazon Redshift is a fast, fully managed, petabyte-scale data warehouse service that makes it simple and cost-effective to efficiently analyze all your data using your existing business intelligence tools.
+<!--custom.overview.start-->
+<!--custom.overview.end-->
+
+_Amazon Redshift is a fast, fully managed, petabyte-scale data warehouse service that makes it simple and cost-effective to efficiently analyze all your data using your existing business intelligence tools._
 
 ## ⚠ Important
 
-* Running this code might result in charges to your AWS account. 
+* 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-->
+
 ## Code examples
 
-### Actions
+### Prerequisites
 
-Code excerpts that show you how to call individual service functions:
+For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv4` folder.
 
-- [CreateCluster](Actions/RedshiftWrapper.cs#L28) (`CreateCluster`)
-- [DeleteCluster](Actions/RedshiftWrapper.cs#L118) (`DeleteCluster`)
-- [DescribeClusters](Actions/RedshiftWrapper.cs#L69) (`DescribeClusters`)
-- [ModifyCluster](Actions/RedshiftWrapper.cs#L96) (`ModifyCluster`)
-- [CreateTable](Actions/RedshiftWrapper.cs#L157) (`ExecuteStatement`)
-- [InsertMovie](Actions/RedshiftWrapper.cs#L193) (`ExecuteStatement`)
-- [QueryMoviesByYear](Actions/RedshiftWrapper.cs#L227) (`ExecuteStatement`, `GetStatementResult`)
-- [DescribeStatement](Actions/RedshiftWrapper.cs#L269) (`DescribeStatement`)
-- [GetStatementResult](Actions/RedshiftWrapper.cs#L289) (`GetStatementResult`)
-- [ListDatabases](Actions/RedshiftWrapper.cs#L130) (`ListDatabases`)
 
-### Scenarios
+<!--custom.prerequisites.start-->
+<!--custom.prerequisites.end-->
 
-Code examples that show you how to accomplish a specific task by calling multiple functions within the same service:
+### Get started
 
-- [Get started with Redshift clusters](Scenarios/RedshiftBasics.cs) - Learn the basics of Amazon Redshift by creating a cluster, adding a table, inserting data, and querying the table.
+- [Hello Amazon Redshift](Actions/HelloRedshift.cs#L20) (`DescribeClusters`)
 
-### Hello
 
-- [Hello Amazon Redshift](Hello/HelloRedshift.cs) - A simple example that shows how to get started with Amazon Redshift by listing existing clusters.
+### Basics
 
-## Run the examples
+Code examples that show you how to perform the essential operations within a service.
 
-### Prerequisites
+- [Learn the basics](Actions/RedshiftWrapper.cs)
 
-For general prerequisites, see the [README](../../README.md) in the `dotnetv4` folder.
 
-After the example compiles, you can run it from the command line. To do so, navigate to the folder that contains the .csproj file and run the following command:
+### Single actions
 
-```
-dotnet run
-```
+Code excerpts that show you how to call individual service functions.
 
-Alternatively, you can run the example from within your IDE.
+- [CreateCluster](Actions/RedshiftWrapper.cs#L34)
+- [DeleteCluster](Actions/RedshiftWrapper.cs#L143)
+- [DescribeClusters](Actions/RedshiftWrapper.cs#L77)
+- [DescribeStatement](Actions/RedshiftWrapper.cs#L375)
+- [GetStatementResult](Actions/RedshiftWrapper.cs#L406)
+- [ListDatabases](Actions/RedshiftWrapper.cs#L176)
+- [ModifyCluster](Actions/RedshiftWrapper.cs#L109)
 
-### Hello Amazon Redshift
 
-This example shows you how to get started using Amazon Redshift.
+<!--custom.examples.start-->
+<!--custom.examples.end-->
 
-#### Purpose
+## Run the examples
 
-Shows how to use the AWS SDK for .NET to get started using Amazon Redshift. Lists existing Redshift clusters in your account.
+### Instructions
 
-### Redshift Basics Scenario
 
-This scenario demonstrates how to interact with Amazon Redshift using the AWS SDK for .NET. It demonstrates various tasks such as creating a Redshift cluster, verifying its readiness, creating a table, populating the table with data, executing SQL queries, and finally cleaning up resources.
+<!--custom.instructions.start-->
+<!--custom.instructions.end-->
 
-#### Purpose
+#### Hello Amazon Redshift
 
-Demonstrates how to:
+This example shows you how to get started using Amazon Redshift.
 
-1. Create an Amazon Redshift cluster.
-2. Wait for the cluster to become available.
-3. List databases in the cluster.
-4. Create a "Movies" table.
-5. Populate the "Movies" table using sample data.
-6. Query the "Movies" table by year.
-7. Modify the Redshift cluster.
-8. Delete the Amazon Redshift cluster.
 
-#### Usage
+#### Learn the basics
 
-1. Clone the repository or download the source code files.
-2. Open the code in your preferred .NET IDE.
-3. Update the following variables in the `RunScenarioAsync()` method if needed:
-   - `userName`: The username for the Redshift cluster.
-   - `userPassword`: The password for the Redshift cluster.
-   - `databaseName`: The name of the database to use ("dev").
-4. Run the `RedshiftBasics` class.
+This example shows you how to do the following:
 
-The program will guide you through the scenario, prompting you to enter a cluster ID and the number of records to add to the "Movies" table. The program will also display the progress and results of the various operations.
+- Create a Redshift cluster.
+- List databases in the cluster.
+- Create a table named Movies.
+- Populate the Movies table.
+- Query the Movies table by year.
+- Modify the Redshift cluster.
+- Delete the Amazon Redshift cluster.
 
-## Tests
+<!--custom.basic_prereqs.redshift_Scenario.start-->
+<!--custom.basic_prereqs.redshift_Scenario.end-->
 
-### Unit tests
 
-Unit tests in this solution use MSTest. The tests use Moq to mock AWS service client dependencies.
+<!--custom.basics.redshift_Scenario.start-->
+<!--custom.basics.redshift_Scenario.end-->
 
-Run unit tests with this command:
 
-```
-dotnet test Tests/RedshiftTests.csproj
-```
+### Tests
 
-### Integration tests
+⚠ Running tests might result in charges to your AWS account.
 
-⚠️ Running the integration tests might result in charges to your AWS account.
 
-The integration tests in this solution require access to AWS services and will create and delete AWS resources. Make sure you have valid AWS credentials configured before running these tests.
+To find instructions for running these tests, see the [README](../README.md#Tests)
+in the `dotnetv4` folder.
 
-Run integration tests with this command:
 
-```
-dotnet test IntegrationTests/RedshiftIntegrationTests.csproj
-```
 
-Note: The full workflow integration test can take 10-15 minutes to complete due to cluster creation time.
+<!--custom.tests.start-->
+<!--custom.tests.end-->
 
 ## Additional resources
 
 - [Amazon Redshift Management Guide](https://docs.aws.amazon.com/redshift/latest/mgmt/welcome.html)
 - [Amazon Redshift API Reference](https://docs.aws.amazon.com/redshift/latest/APIReference/Welcome.html)
-- [SDK for .NET Amazon Redshift reference](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Redshift/NRedshift.html)
+- [SDK for .NET (v4) Amazon Redshift reference](https://docs.aws.amazon.com/sdkfornet/v4/apidocs/items/Redshift/NRedshift.html)
+
+<!--custom.resources.start-->
+<!--custom.resources.end-->
 
 ---
 
-Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.  
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
 SPDX-License-Identifier: Apache-2.0