Skip to content

Commit

Permalink
.NET v3: Update READMEs in .NET folder with WriteMe. (#5495)
Browse files Browse the repository at this point in the history
  • Loading branch information
rlhagerm authored Oct 16, 2023
1 parent e004a24 commit a8f5bb5
Show file tree
Hide file tree
Showing 35 changed files with 295 additions and 228 deletions.
2 changes: 1 addition & 1 deletion .doc_gen/readmes/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
'auto-scaling': 'dotnetv3/AutoScaling',
'cloudwatch': 'dotnetv3/CloudWatch',
'cloudwatch-logs': 'dotnetv3/CloudWatchLogs',
'cognito': 'dotnetv3/Cognito',
'cognito-identity-provider': 'dotnetv3/Cognito',
'comprehend': 'dotnetv3/Comprehend',
'dynamodb': 'dotnetv3/dynamodb',
'ec2': 'dotnetv3/EC2',
Expand Down
4 changes: 3 additions & 1 deletion .doc_gen/readmes/render.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@ def _transform_service(self):
def _transform_actions(self, pre_actions):
post_actions = []
for _, pre in pre_actions.items():
api = next(iter(pre['services'][self.scanner.svc_name]))
api = ""
if pre['services'][self.scanner.svc_name]:
api = next(iter(pre['services'][self.scanner.svc_name]))
action = {
'title_abbrev': pre['title_abbrev'],
'synopsis': pre['synopsis'],
Expand Down
14 changes: 8 additions & 6 deletions dotnetv3/ACM/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--Generated by WRITEME on 2023-04-25 15:52:39.082687 (UTC)-->
<!--Generated by WRITEME on 2023-10-12 19:26:12.849162 (UTC)-->
# ACM code examples for the SDK for .NET

## Overview
Expand All @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Certificate Manager (ACM)

## ⚠ 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/?aws-products-pricing.sort-by=item.additionalFields.productNameLowercase&aws-products-pricing.sort-order=asc&awsf.Free%20Tier%20Type=*all&awsf.tech-category=*all) and [Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all).
* 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).
Expand Down Expand Up @@ -42,20 +42,22 @@ Code excerpts that show you how to call individual service functions.
### Instructions


For general instructions to run the examples, see the [README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.
For general instructions to run the examples, see the
[README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.

Some projects might include a settings.json file. Before compiling the project,
you can change these values to match your own account and resources. Alternatively, add a settings.local.json file with
your local settings, which will be loaded automatically when the application runs.
you can change these values to match your own account and resources. Alternatively,
add a settings.local.json file with your local settings, which will be loaded automatically
when the application runs.

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:

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

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

<!--custom.instructions.start-->
<!--custom.instructions.end-->
Expand Down
18 changes: 10 additions & 8 deletions dotnetv3/Aurora/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--Generated by WRITEME on 2023-04-25 15:54:03.007281 (UTC)-->
<!--Generated by WRITEME on 2023-10-12 19:26:13.060702 (UTC)-->
# Aurora code examples for the SDK for .NET

## Overview
Expand All @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Aurora.

## ⚠ 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/?aws-products-pricing.sort-by=item.additionalFields.productNameLowercase&aws-products-pricing.sort-order=asc&awsf.Free%20Tier%20Type=*all&awsf.tech-category=*all) and [Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all).
* 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).
Expand Down Expand Up @@ -60,33 +60,35 @@ Code excerpts that show you how to call individual service functions.
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.

* [Get started with DB clusters](Scenarios/AuroraScenario.cs)
* [Get started with DB clusters](Scenarios/AuroraScenario.cs)

### Cross-service examples

Sample applications that work across multiple AWS services.

* [Create an Aurora Serverless work item tracker](../cross_service/AuroraItemTracker)
* [Create an Aurora Serverless work item tracker](../cross_service/AuroraItemTracker)

## Run the examples

### Instructions


For general instructions to run the examples, see the [README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.
For general instructions to run the examples, see the
[README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.

Some projects might include a settings.json file. Before compiling the project,
you can change these values to match your own account and resources. Alternatively, add a settings.local.json file with
your local settings, which will be loaded automatically when the application runs.
you can change these values to match your own account and resources. Alternatively,
add a settings.local.json file with your local settings, which will be loaded automatically
when the application runs.

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:

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

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

<!--custom.instructions.start-->
<!--custom.instructions.end-->
Expand Down
6 changes: 3 additions & 3 deletions dotnetv3/AutoScaling/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--Generated by WRITEME on 2023-07-05 21:19:50.090803 (UTC)-->
<!--Generated by WRITEME on 2023-10-12 19:26:13.196633 (UTC)-->
# Auto Scaling code examples for the SDK for .NET

## Overview
Expand All @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon EC2 Auto Scaling.

## ⚠ 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/?aws-products-pricing.sort-by=item.additionalFields.productNameLowercase&aws-products-pricing.sort-order=asc&awsf.Free%20Tier%20Type=*all&awsf.tech-category=*all) and [Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all).
* 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).
Expand Down Expand Up @@ -55,7 +55,7 @@ Code excerpts that show you how to call individual service functions.
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.

* [Manage groups and instances](Scenarios/AutoScalingBasics/UIWrapper.cs)
* [Manage groups and instances](Scenarios/AutoScalingBasics/UIWrapper.cs)

## Run the examples

Expand Down
16 changes: 9 additions & 7 deletions dotnetv3/CloudWatch/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--Generated by WRITEME on 2023-04-25 15:58:25.759260 (UTC)-->
<!--Generated by WRITEME on 2023-10-12 19:26:13.382772 (UTC)-->
# CloudWatch code examples for the SDK for .NET

## Overview
Expand All @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon CloudWatch.

## ⚠ 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/?aws-products-pricing.sort-by=item.additionalFields.productNameLowercase&aws-products-pricing.sort-order=asc&awsf.Free%20Tier%20Type=*all&awsf.tech-category=*all) and [Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all).
* 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).
Expand Down Expand Up @@ -66,27 +66,29 @@ Code excerpts that show you how to call individual service functions.
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.

* [Get started with metrics, dashboards, and alarms](Scenarios/CloudWatchScenario.cs)
* [Get started with metrics, dashboards, and alarms](Scenarios/CloudWatchScenario.cs)

## Run the examples

### Instructions


For general instructions to run the examples, see the [README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.
For general instructions to run the examples, see the
[README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.

Some projects might include a settings.json file. Before compiling the project,
you can change these values to match your own account and resources. Alternatively, add a settings.local.json file with
your local settings, which will be loaded automatically when the application runs.
you can change these values to match your own account and resources. Alternatively,
add a settings.local.json file with your local settings, which will be loaded automatically
when the application runs.

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:

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

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

<!--custom.instructions.start-->
<!--custom.instructions.end-->
Expand Down
14 changes: 8 additions & 6 deletions dotnetv3/CloudWatchLogs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--Generated by WRITEME on 2023-04-25 15:58:37.216428 (UTC)-->
<!--Generated by WRITEME on 2023-10-12 19:26:13.468771 (UTC)-->
# CloudWatch Logs code examples for the SDK for .NET

## Overview
Expand All @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon CloudWatch Logs.

## ⚠ 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/?aws-products-pricing.sort-by=item.additionalFields.productNameLowercase&aws-products-pricing.sort-order=asc&awsf.Free%20Tier%20Type=*all&awsf.tech-category=*all) and [Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all).
* 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).
Expand Down Expand Up @@ -48,20 +48,22 @@ Code excerpts that show you how to call individual service functions.
### Instructions


For general instructions to run the examples, see the [README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.
For general instructions to run the examples, see the
[README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.

Some projects might include a settings.json file. Before compiling the project,
you can change these values to match your own account and resources. Alternatively, add a settings.local.json file with
your local settings, which will be loaded automatically when the application runs.
you can change these values to match your own account and resources. Alternatively,
add a settings.local.json file with your local settings, which will be loaded automatically
when the application runs.

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:

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

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

<!--custom.instructions.start-->
<!--custom.instructions.end-->
Expand Down
10 changes: 5 additions & 5 deletions dotnetv3/Cognito/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--Generated by WRITEME on 2023-08-28 16:45:43.695374 (UTC)-->
<!--Generated by WRITEME on 2023-10-12 19:43:20.620912 (UTC)-->
# Amazon Cognito Identity Provider code examples for the SDK for .NET

## Overview
Expand All @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Cognito Identity Provi

## ⚠ 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/?aws-products-pricing.sort-by=item.additionalFields.productNameLowercase&aws-products-pricing.sort-order=asc&awsf.Free%20Tier%20Type=*all&awsf.tech-category=*all) and [Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all).
* 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).
Expand All @@ -24,7 +24,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Cognito Identity Provi

### Prerequisites

For prerequisites, see the [README](README.md#Prerequisites) in the `dotnetv3` folder.
For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3` folder.


<!--custom.prerequisites.start-->
Expand Down Expand Up @@ -62,7 +62,7 @@ Code excerpts that show you how to call individual service functions.
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.

* [Sign up a user with a user pool that requires MFA](Actions/CognitoWrapper.cs)
* [Sign up a user with a user pool that requires MFA](Actions/CognitoWrapper.cs)

## Run the examples

Expand Down Expand Up @@ -111,7 +111,7 @@ This example shows you how to do the following:
⚠ Running tests might result in charges to your AWS account.


To find instructions for running these tests, see the [README](README.md#Tests)
To find instructions for running these tests, see the [README](../README.md#Tests)
in the `dotnetv3` folder.


Expand Down
14 changes: 8 additions & 6 deletions dotnetv3/Comprehend/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--Generated by WRITEME on 2023-04-25 16:05:31.863891 (UTC)-->
<!--Generated by WRITEME on 2023-10-12 19:26:13.709762 (UTC)-->
# Amazon Comprehend code examples for the SDK for .NET

## Overview
Expand All @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Comprehend.

## ⚠ 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/?aws-products-pricing.sort-by=item.additionalFields.productNameLowercase&aws-products-pricing.sort-order=asc&awsf.Free%20Tier%20Type=*all&awsf.tech-category=*all) and [Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all).
* 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).
Expand Down Expand Up @@ -47,20 +47,22 @@ Code excerpts that show you how to call individual service functions.
### Instructions


For general instructions to run the examples, see the [README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.
For general instructions to run the examples, see the
[README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder.

Some projects might include a settings.json file. Before compiling the project,
you can change these values to match your own account and resources. Alternatively, add a settings.local.json file with
your local settings, which will be loaded automatically when the application runs.
you can change these values to match your own account and resources. Alternatively,
add a settings.local.json file with your local settings, which will be loaded automatically
when the application runs.

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:

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

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

<!--custom.instructions.start-->
<!--custom.instructions.end-->
Expand Down
Loading

0 comments on commit a8f5bb5

Please sign in to comment.