From a8f5bb573084559ad45617460a09fda09f8ac7cf Mon Sep 17 00:00:00 2001 From: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Date: Mon, 16 Oct 2023 10:20:19 -0500 Subject: [PATCH] .NET v3: Update READMEs in .NET folder with WriteMe. (#5495) --- .doc_gen/readmes/config.py | 2 +- .doc_gen/readmes/render.py | 4 +++- dotnetv3/ACM/README.md | 14 +++++++------ dotnetv3/Aurora/README.md | 18 +++++++++------- dotnetv3/AutoScaling/README.md | 6 +++--- dotnetv3/CloudWatch/README.md | 16 +++++++------- dotnetv3/CloudWatchLogs/README.md | 14 +++++++------ dotnetv3/Cognito/README.md | 10 ++++----- dotnetv3/Comprehend/README.md | 14 +++++++------ dotnetv3/EC2/README.md | 20 +++++++++--------- dotnetv3/ECS/README.md | 6 +++--- dotnetv3/EventBridge/README.md | 16 +++++++------- dotnetv3/Glacier/README.md | 18 +++++++++------- dotnetv3/Glue/README.md | 17 ++++++++------- dotnetv3/IAM/README.md | 18 +++++++++------- dotnetv3/KMS/README.md | 14 +++++++------ dotnetv3/Keyspaces/README.md | 16 +++++++------- dotnetv3/Kinesis/README.md | 14 +++++++------ dotnetv3/Lambda/README.md | 22 ++++++++++++------- dotnetv3/MediaConvert/README.md | 14 +++++++------ dotnetv3/Organizations/README.md | 14 +++++++------ dotnetv3/Polly/README.md | 14 +++++++------ dotnetv3/RDS/README.md | 8 +++---- dotnetv3/Rekognition/README.md | 17 ++++++++------- dotnetv3/S3/README.md | 35 +++++++++++++++++-------------- dotnetv3/SES/README.md | 20 ++++++++++-------- dotnetv3/SNS/README.md | 17 +++++---------- dotnetv3/SQS/README.md | 23 ++++++++++++++++---- dotnetv3/STS/README.md | 14 +++++++------ dotnetv3/SageMaker/README.md | 10 ++++----- dotnetv3/SecretsManager/README.md | 14 +++++++------ dotnetv3/Support/README.md | 16 +++++++------- dotnetv3/Transcribe/README.md | 14 +++++++------ dotnetv3/Translate/README.md | 16 +++++++------- dotnetv3/dynamodb/README.md | 18 ++++++++-------- 35 files changed, 295 insertions(+), 228 deletions(-) diff --git a/.doc_gen/readmes/config.py b/.doc_gen/readmes/config.py index abc1bb415c0..f99f35129b1 100644 --- a/.doc_gen/readmes/config.py +++ b/.doc_gen/readmes/config.py @@ -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', diff --git a/.doc_gen/readmes/render.py b/.doc_gen/readmes/render.py index 72542f6ab7b..e5c01040319 100644 --- a/.doc_gen/readmes/render.py +++ b/.doc_gen/readmes/render.py @@ -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'], diff --git a/dotnetv3/ACM/README.md b/dotnetv3/ACM/README.md index 918f40baffc..2a6b417e63f 100644 --- a/dotnetv3/ACM/README.md +++ b/dotnetv3/ACM/README.md @@ -1,4 +1,4 @@ - + # ACM code examples for the SDK for .NET ## Overview @@ -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). @@ -42,11 +42,13 @@ 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: @@ -54,8 +56,8 @@ 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. diff --git a/dotnetv3/Aurora/README.md b/dotnetv3/Aurora/README.md index bf019ab3487..85f0e90095d 100644 --- a/dotnetv3/Aurora/README.md +++ b/dotnetv3/Aurora/README.md @@ -1,4 +1,4 @@ - + # Aurora code examples for the SDK for .NET ## Overview @@ -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). @@ -60,24 +60,26 @@ 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: @@ -85,8 +87,8 @@ 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. diff --git a/dotnetv3/AutoScaling/README.md b/dotnetv3/AutoScaling/README.md index 3e33956dc62..7c302dd1433 100644 --- a/dotnetv3/AutoScaling/README.md +++ b/dotnetv3/AutoScaling/README.md @@ -1,4 +1,4 @@ - + # Auto Scaling code examples for the SDK for .NET ## Overview @@ -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). @@ -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 diff --git a/dotnetv3/CloudWatch/README.md b/dotnetv3/CloudWatch/README.md index a06f1610cb3..c926a066ec2 100644 --- a/dotnetv3/CloudWatch/README.md +++ b/dotnetv3/CloudWatch/README.md @@ -1,4 +1,4 @@ - + # CloudWatch code examples for the SDK for .NET ## Overview @@ -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). @@ -66,18 +66,20 @@ 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: @@ -85,8 +87,8 @@ 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. diff --git a/dotnetv3/CloudWatchLogs/README.md b/dotnetv3/CloudWatchLogs/README.md index c6106dcaedc..578e9bece35 100644 --- a/dotnetv3/CloudWatchLogs/README.md +++ b/dotnetv3/CloudWatchLogs/README.md @@ -1,4 +1,4 @@ - + # CloudWatch Logs code examples for the SDK for .NET ## Overview @@ -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). @@ -48,11 +48,13 @@ 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: @@ -60,8 +62,8 @@ 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. diff --git a/dotnetv3/Cognito/README.md b/dotnetv3/Cognito/README.md index 101e8e7331a..a480eb6e361 100644 --- a/dotnetv3/Cognito/README.md +++ b/dotnetv3/Cognito/README.md @@ -1,4 +1,4 @@ - + # Amazon Cognito Identity Provider code examples for the SDK for .NET ## Overview @@ -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). @@ -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. @@ -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 @@ -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. diff --git a/dotnetv3/Comprehend/README.md b/dotnetv3/Comprehend/README.md index 8ce73b2d761..d1c7c54ea65 100644 --- a/dotnetv3/Comprehend/README.md +++ b/dotnetv3/Comprehend/README.md @@ -1,4 +1,4 @@ - + # Amazon Comprehend code examples for the SDK for .NET ## Overview @@ -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). @@ -47,11 +47,13 @@ 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: @@ -59,8 +61,8 @@ 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. diff --git a/dotnetv3/EC2/README.md b/dotnetv3/EC2/README.md index 78988c3b3e8..f42140db0be 100644 --- a/dotnetv3/EC2/README.md +++ b/dotnetv3/EC2/README.md @@ -1,4 +1,4 @@ - + # Amazon EC2 code examples for the SDK for .NET ## Overview @@ -8,11 +8,11 @@ Shows how to use the AWS SDK for .NET to work with Amazon Elastic Compute Cloud -*Amazon EC2 is a web service that provides resizable computing capacity—literally, servers in Amazon's data centers—that you use to build and host your software systems.* +*Amazon EC2 is a web service that provides resizable computing capacity—literally, servers in Amazon's data centers—that you use to build and host your software systems.* ## ⚠ 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). @@ -41,11 +41,9 @@ Code excerpts that show you how to call individual service functions. * [Allocate an Elastic IP address](Actions/EC2Wrapper.cs#L19) (`AllocateAddress`) * [Associate an Elastic IP address with an instance](Actions/EC2Wrapper.cs#L33) (`AssociateAddress`) -* [Create a VPC](Actions/EC2Wrapper.cs#L162) (`CreateVpc`) * [Create a security group](Actions/EC2Wrapper.cs#L145) (`CreateSecurityGroup`) * [Create a security key pair](Actions/EC2Wrapper.cs#L98) (`CreateKeyPair`) * [Create and run an instance](Actions/EC2Wrapper.cs#L587) (`RunInstances`) -* [Delete a VPC](Actions/EC2Wrapper.cs#L236) (`DeleteVpc`) * [Delete a security group](Actions/EC2Wrapper.cs#L223) (`DeleteSecurityGroup`) * [Delete a security key pair](Actions/EC2Wrapper.cs#L190) (`DeleteKeyPair`) * [Describe instances](Actions/EC2Wrapper.cs#L316) (`DescribeInstances`) @@ -65,18 +63,20 @@ 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 instances](Scenarios/EC2_Basics/EC2Basics.cs) +* [Get started with instances](Scenarios/EC2_Basics/EC2Basics.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: @@ -84,8 +84,8 @@ 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. diff --git a/dotnetv3/ECS/README.md b/dotnetv3/ECS/README.md index ffce5651eca..a28d03bbea1 100644 --- a/dotnetv3/ECS/README.md +++ b/dotnetv3/ECS/README.md @@ -1,4 +1,4 @@ - + # Amazon ECS code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Elastic Container Serv ## ⚠ 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). @@ -48,7 +48,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. -* [Get ARN information for clusters, services, and tasks](ECSScenario/ECSScenario.cs) +* [Get ARN information for clusters, services, and tasks](ECSScenario/ECSScenario.cs) ## Run the examples diff --git a/dotnetv3/EventBridge/README.md b/dotnetv3/EventBridge/README.md index a76c74b9ea5..49e4b51583c 100644 --- a/dotnetv3/EventBridge/README.md +++ b/dotnetv3/EventBridge/README.md @@ -1,4 +1,4 @@ - + # EventBridge code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon EventBridge. ## ⚠ 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). @@ -56,18 +56,20 @@ 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 rules and targets](Scenarios/EventBridgeScenario.cs) +* [Get started with rules and targets](Scenarios/EventBridgeScenario.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: @@ -75,8 +77,8 @@ 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. diff --git a/dotnetv3/Glacier/README.md b/dotnetv3/Glacier/README.md index b6cd9f31b72..e35f8ca7984 100644 --- a/dotnetv3/Glacier/README.md +++ b/dotnetv3/Glacier/README.md @@ -1,4 +1,4 @@ - + # S3 Glacier code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon S3 Glacier. ## ⚠ 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). @@ -33,7 +33,7 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3 ### Get started -* [Hello Amazon S3 Glacier](None) (`ListVaults`) +* [Hello Amazon S3 Glacier](Actions/HelloGlacier.cs#L4) (`ListVaults`) ### Single actions @@ -42,7 +42,7 @@ Code excerpts that show you how to call individual service functions. * [Add tags](Actions/GlacierWrapper.cs#L33) (`AddTagsToVault`) * [Create a vault](Actions/GlacierWrapper.cs#L58) (`CreateVault`) * [Describe a vault](Actions/GlacierWrapper.cs#L83) (`DescribeVault`) -* [Download an archive](Actions/GlacierWrapper.cs#L112) (`DownloadArchive`) +* [Download an archive](Actions/GlacierWrapper.cs) * [List jobs](Actions/GlacierWrapper.cs#L164) (`ListJobs`) * [List tags](Actions/GlacierWrapper.cs#L188) (`ListTagsForVault`) * [List vaults](Actions/GlacierWrapper.cs#L213) (`ListVaults`) @@ -53,11 +53,13 @@ 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: @@ -65,8 +67,8 @@ 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. diff --git a/dotnetv3/Glue/README.md b/dotnetv3/Glue/README.md index 21f91fabaa4..ea18e0f9500 100644 --- a/dotnetv3/Glue/README.md +++ b/dotnetv3/Glue/README.md @@ -1,4 +1,4 @@ - + # AWS Glue code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Glue. ## ⚠ 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). @@ -59,18 +59,20 @@ 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 crawlers and jobs](Actions/GlueWrapper.cs) +* [Get started with crawlers and jobs](Actions/GlueWrapper.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: @@ -78,8 +80,8 @@ 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. @@ -133,6 +135,7 @@ Example: + diff --git a/dotnetv3/IAM/README.md b/dotnetv3/IAM/README.md index 9c59987176a..f7cbc5ffcdd 100644 --- a/dotnetv3/IAM/README.md +++ b/dotnetv3/IAM/README.md @@ -1,4 +1,4 @@ - + # IAM code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Identity and Access Manag ## ⚠ 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). @@ -76,19 +76,21 @@ 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. -* [Create a group and add a user](Scenarios/IamScenariosCommon/UIWrapper.cs) -* [Create a user and assume a role](Scenarios/IamScenariosCommon/UIWrapper.cs) +* [Create a group and add a user](Scenarios/IamScenariosCommon/UIWrapper.cs) +* [Create a user and assume a role](Scenarios/IamScenariosCommon/UIWrapper.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: @@ -96,8 +98,8 @@ 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. To run the examples, see the [README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder. diff --git a/dotnetv3/KMS/README.md b/dotnetv3/KMS/README.md index e929335e007..cddb8672b32 100644 --- a/dotnetv3/KMS/README.md +++ b/dotnetv3/KMS/README.md @@ -1,4 +1,4 @@ - + # AWS KMS code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Key Management Service (A ## ⚠ 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). @@ -49,11 +49,13 @@ 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: @@ -61,8 +63,8 @@ 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. To run the examples, see the [README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder. diff --git a/dotnetv3/Keyspaces/README.md b/dotnetv3/Keyspaces/README.md index bb6ff038e5d..97e642374bd 100644 --- a/dotnetv3/Keyspaces/README.md +++ b/dotnetv3/Keyspaces/README.md @@ -1,4 +1,4 @@ - + # Amazon Keyspaces code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Keyspaces (for Apache ## ⚠ 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). @@ -55,18 +55,20 @@ 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 keyspaces and tables](Scenarios/KeyspacesBasics.cs) +* [Get started with keyspaces and tables](Scenarios/KeyspacesBasics.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: @@ -74,8 +76,8 @@ 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. diff --git a/dotnetv3/Kinesis/README.md b/dotnetv3/Kinesis/README.md index 01dc402d539..9e698f9e076 100644 --- a/dotnetv3/Kinesis/README.md +++ b/dotnetv3/Kinesis/README.md @@ -1,4 +1,4 @@ - + # Kinesis code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Kinesis. ## ⚠ 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). @@ -48,11 +48,13 @@ 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: @@ -60,8 +62,8 @@ 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. To run the examples, see the [README](../README.md#building-and-running-the-code-examples) in the `dotnetv3` folder. diff --git a/dotnetv3/Lambda/README.md b/dotnetv3/Lambda/README.md index 87d49ec1857..25ee5f55a5a 100644 --- a/dotnetv3/Lambda/README.md +++ b/dotnetv3/Lambda/README.md @@ -1,4 +1,4 @@ - + # Lambda code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Lambda. ## ⚠ 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). @@ -52,18 +52,26 @@ 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 functions](Actions/LambdaWrapper.cs) +* [Get started with functions](Actions/LambdaWrapper.cs) + +### Cross-service examples + +Sample applications that work across multiple AWS services. + +* [Create a serverless application to manage photos](dotnetv3\cross-service\PhotoAssetManager) ## 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: @@ -71,8 +79,8 @@ 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. diff --git a/dotnetv3/MediaConvert/README.md b/dotnetv3/MediaConvert/README.md index 2767073aeec..207117c8870 100644 --- a/dotnetv3/MediaConvert/README.md +++ b/dotnetv3/MediaConvert/README.md @@ -1,4 +1,4 @@ - + # MediaConvert code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Elemental MediaConvert. ## ⚠ 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). @@ -48,11 +48,13 @@ 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: @@ -60,8 +62,8 @@ 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. diff --git a/dotnetv3/Organizations/README.md b/dotnetv3/Organizations/README.md index b83f7fdcdbc..3b69e8d48be 100644 --- a/dotnetv3/Organizations/README.md +++ b/dotnetv3/Organizations/README.md @@ -1,4 +1,4 @@ - + # Organizations code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Organizations. ## ⚠ 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). @@ -52,11 +52,13 @@ 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: @@ -64,8 +66,8 @@ 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. diff --git a/dotnetv3/Polly/README.md b/dotnetv3/Polly/README.md index 4ce7925522e..4cfe84c6f17 100644 --- a/dotnetv3/Polly/README.md +++ b/dotnetv3/Polly/README.md @@ -1,4 +1,4 @@ - + # Amazon Polly code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Polly. ## ⚠ 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). @@ -46,11 +46,13 @@ 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: @@ -58,8 +60,8 @@ 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. diff --git a/dotnetv3/RDS/README.md b/dotnetv3/RDS/README.md index a05b16333d7..d169158feda 100644 --- a/dotnetv3/RDS/README.md +++ b/dotnetv3/RDS/README.md @@ -1,4 +1,4 @@ - + # Amazon RDS code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Relational Database Se ## ⚠ 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). @@ -57,13 +57,13 @@ 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 instances](Scenarios/RDSInstanceScenario/RDSInstanceScenario.cs) +* [Get started with DB instances](Scenarios/RDSInstanceScenario/RDSInstanceScenario.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 diff --git a/dotnetv3/Rekognition/README.md b/dotnetv3/Rekognition/README.md index ddc68a4e8d6..d7f8c4e74c4 100644 --- a/dotnetv3/Rekognition/README.md +++ b/dotnetv3/Rekognition/README.md @@ -1,4 +1,4 @@ - + # Amazon Rekognition code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Rekognition. ## ⚠ 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). @@ -55,18 +55,21 @@ Code excerpts that show you how to call individual service functions. Sample applications that work across multiple AWS services. -* [Detect objects in images](../cross-service/PhotoAnalyzerApp) +* [Create a serverless application to manage photos](dotnetv3\cross-service\PhotoAssetManager) +* [Detect objects in images](../cross-service/PhotoAnalyzerApp) ## 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: @@ -74,8 +77,8 @@ 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. diff --git a/dotnetv3/S3/README.md b/dotnetv3/S3/README.md index 0bd25f44bcf..89ca5709282 100644 --- a/dotnetv3/S3/README.md +++ b/dotnetv3/S3/README.md @@ -1,4 +1,4 @@ - + # Amazon S3 code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Simple Storage Service ## ⚠ 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). @@ -44,7 +44,7 @@ Code excerpts that show you how to call individual service functions. * [Delete an object](non-versioned-examples/DeleteObjectExample/DeleteObject.cs#L11) (`DeleteObject`) * [Delete multiple objects](S3_Basics/S3Bucket.cs#L221) (`DeleteObjects`) * [Delete the lifecycle configuration of a bucket](LifecycleExample/Lifecycle.cs#L193) (`DeleteBucketLifecycle`) -* [Enable logging](ServerAccessLoggingExample/ServerAccessLogging.cs#L14) (`PutBucketLogging`) +* [Enable logging](ServerAccessLoggingExample/ServerAccessLogging.cs#L15) (`PutBucketLogging`) * [Enable notifications](EnableNotificationsExample/EnableNotifications.cs#L11) (`PutBucketNotificationConfiguration`) * [Enable transfer acceleration](TransferAccelerationExample/TransferAcceleration.cs#L13) (`PutBucketAccelerateConfiguration`) * [Get CORS rules for a bucket](s3CORSExample/S3CORS.cs#L126) (`GetBucketCors`) @@ -54,7 +54,7 @@ Code excerpts that show you how to call individual service functions. * [Get the website configuration for a bucket](WebsiteConfigExample/WebsiteConfig.cs#L72) (`GetBucketWebsite`) * [List buckets](ListBucketsExample/ListBuckets.cs#L4) (`ListBuckets`) * [List object versions in a bucket](versioned-examples/ListObjectVersionsExample/ListObjectVersions.cs#L11) (`ListObjectVersions`) -* [List objects in a bucket](S3_Basics/S3Bucket.cs#L171) (`ListObjects`) +* [List objects in a bucket](S3_Basics/S3Bucket.cs#L171) (`ListObjectsV2`) * [Restore an archived copy of an object](RestoreArchivedObjectExample/RestoreArchivedObject.cs#L11) (`RestoreObject`) * [Set a new ACL for a bucket](BucketACLExample/BucketACL.cs#L38) (`PutBucketAcl`) * [Set the website configuration for a bucket](WebsiteConfigExample/WebsiteConfig.cs#L58) (`PutBucketWebsite`) @@ -65,30 +65,33 @@ 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. -* [Create a presigned URL](GenPresignedURLExample/GenPresignedUrl.cs) -* [Get started with buckets and objects](S3_Basics/S3_Basics.cs) -* [Get started with encryption](SSEClientEncryptionExample/SSEClientEncryption.cs) -* [Get started with tags](ObjectTagExample/ObjectTag.cs) -* [Manage access control lists (ACLs)](ManageACLsExample/ManageACLs.cs) -* [Perform a multipart copy](MPUapiCopyObjExample/MPUapiCopyObj.cs) -* [Upload or download large files](scenarios/TransferUtilityBasics/TransferUtilityBasics/TransferBasics.cs) +* [Create a presigned URL](GenPresignedURLExample/GenPresignedUrl.cs) +* [Get started with buckets and objects](S3_Basics/S3_Basics.cs) +* [Get started with encryption](SSEClientEncryptionExample/SSEClientEncryption.cs) +* [Get started with tags](ObjectTagExample/ObjectTag.cs) +* [Manage access control lists (ACLs)](ManageACLsExample/ManageACLs.cs) +* [Perform a multipart copy](MPUapiCopyObjExample/MPUapiCopyObj.cs) +* [Upload or download large files](scenarios/TransferUtilityBasics/TransferUtilityBasics/TransferBasics.cs) ### Cross-service examples Sample applications that work across multiple AWS services. -* [Detect objects in images](../cross-service/PhotoAnalyzerApp) +* [Create a serverless application to manage photos](dotnetv3\cross-service\PhotoAssetManager) +* [Detect objects in images](../cross-service/PhotoAnalyzerApp) ## 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: @@ -96,8 +99,8 @@ 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. diff --git a/dotnetv3/SES/README.md b/dotnetv3/SES/README.md index 79fa032ba09..8d9c081b78e 100644 --- a/dotnetv3/SES/README.md +++ b/dotnetv3/SES/README.md @@ -1,4 +1,4 @@ - + # Amazon SES code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Simple Email Service ( ## ⚠ 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). @@ -49,20 +49,22 @@ Code excerpts that show you how to call individual service functions. Sample applications that work across multiple AWS services. -* [Create a web application to track DynamoDB data](../cross_service/DynamoDbItemTracker) -* [Create an Aurora Serverless work item tracker](../cross_service/AuroraItemTracker) -* [Detect objects in images](../cross-service/PhotoAnalyzerApp) +* [Create a web application to track DynamoDB data](../cross_service/DynamoDbItemTracker) +* [Create an Aurora Serverless work item tracker](../cross_service/AuroraItemTracker) +* [Detect objects in images](../cross-service/PhotoAnalyzerApp) ## 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: @@ -70,8 +72,8 @@ 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. diff --git a/dotnetv3/SNS/README.md b/dotnetv3/SNS/README.md index b0f43aa02d4..8bd47f89149 100644 --- a/dotnetv3/SNS/README.md +++ b/dotnetv3/SNS/README.md @@ -1,4 +1,4 @@ - + # Amazon SNS code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Simple Notification Se ## ⚠ 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). @@ -51,21 +51,14 @@ Code excerpts that show you how to call individual service functions. * [Publish to a topic](PublishToSNSTopicExample/PublishToSNSTopicExample/PublishToSNSTopic.cs#L6) (`Publish`) * [Subscribe an SQS queue to a topic](../cross-service/TopicsAndQueues/Actions/SNSActions/SNSWrapper.cs#L67) (`Subscribe`) * [Subscribe an email address to a topic](ManageTopicSubscriptionExample/ManageTopicSubscriptionExample/ManageTopicSubscription.cs#L38) (`Subscribe`) -* [Subscribe with a filter to a topic](../cross-service/TopicsAndQueues/Actions/SNSActions/SNSWrapper.cs#L94) (`Subscribe`) - -### Scenarios - -Code examples that show you how to accomplish a specific task by calling multiple -functions within the same service. - -* [Publish messages to queues](../cross-service/TopicsAndQueues) +* [Subscribe with a filter to a topic](../cross-service/TopicsAndQueues/Actions/SNSActions/SNSWrapper.cs#L67) (`Subscribe`) ### Cross-service examples Sample applications that work across multiple AWS services. -* [Building an Amazon SNS application](../cross_service/SubscribePublishTranslate) -* [Create a serverless application to manage photos](dotnetv3\cross-service\PhotoAssetManager) +* [Building an Amazon SNS application](../cross_service/SubscribePublishTranslate) +* [Create a serverless application to manage photos](dotnetv3\cross-service\PhotoAssetManager) ## Run the examples diff --git a/dotnetv3/SQS/README.md b/dotnetv3/SQS/README.md index e27f25041fa..93d2b69419f 100644 --- a/dotnetv3/SQS/README.md +++ b/dotnetv3/SQS/README.md @@ -1,4 +1,4 @@ - + # Amazon SQS code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Simple Queue Service ( ## ⚠ 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). @@ -55,8 +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. -* [Publish messages to queues](../cross-service/TopicsAndQueues) - +* [Publish messages to queues](../cross-service/TopicsAndQueues/Scenarios/TopicsAndQueuesScenario/TopicsAndQueues.cs) ## Run the examples @@ -89,6 +88,22 @@ This example shows you how to get started using Amazon SQS. +#### Publish messages to queues + +This example shows you how to do the following: + +* Create topic (FIFO or non-FIFO). +* Subscribe several queues to the topic with an option to apply a filter. +* Publish messages to the topic. +* Poll the queues for messages received. + + + + + + + + ### Tests ⚠ Running tests might result in charges to your AWS account. diff --git a/dotnetv3/STS/README.md b/dotnetv3/STS/README.md index c0639334c61..53531e50246 100644 --- a/dotnetv3/STS/README.md +++ b/dotnetv3/STS/README.md @@ -1,4 +1,4 @@ - + # AWS STS code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Security Token Service (A ## ⚠ 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). @@ -41,11 +41,13 @@ 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: @@ -53,8 +55,8 @@ 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. diff --git a/dotnetv3/SageMaker/README.md b/dotnetv3/SageMaker/README.md index c34d2a61495..11f71719ea0 100644 --- a/dotnetv3/SageMaker/README.md +++ b/dotnetv3/SageMaker/README.md @@ -1,4 +1,4 @@ - + # SageMaker code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon SageMaker. ## ⚠ 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). @@ -40,8 +40,8 @@ For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv3 Code excerpts that show you how to call individual service functions. * [Create a pipeline](Actions/SageMakerWrapper.cs#L25) (`CreatePipeline`) -* [Delete a pipeline](Actions/SageMakerWrapper.cs#L144) (`DeletePipeline`) -* [Describe a pipeline execution](Actions/SageMakerWrapper.cs#L126) (`DescribePipelineExecution`) +* [Delete a pipeline](Actions/SageMakerWrapper.cs#L146) (`DeletePipeline`) +* [Describe a pipeline execution](Actions/SageMakerWrapper.cs#L128) (`DescribePipelineExecution`) * [Execute a pipeline](Actions/SageMakerWrapper.cs#L62) (`StartPipelineExecution`) ### Scenarios @@ -49,7 +49,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. -* [Get started with geospatial jobs and pipelines](Actions/SageMakerWrapper.cs) +* [Get started with geospatial jobs and pipelines](Actions/SageMakerWrapper.cs) ## Run the examples diff --git a/dotnetv3/SecretsManager/README.md b/dotnetv3/SecretsManager/README.md index ce17e58e1e5..d5686c3cca6 100644 --- a/dotnetv3/SecretsManager/README.md +++ b/dotnetv3/SecretsManager/README.md @@ -1,4 +1,4 @@ - + # Secrets Manager code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Secrets Manager. ## ⚠ 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). @@ -41,11 +41,13 @@ 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: @@ -53,8 +55,8 @@ 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. diff --git a/dotnetv3/Support/README.md b/dotnetv3/Support/README.md index c6e94fe2ee9..68f0c0153e4 100644 --- a/dotnetv3/Support/README.md +++ b/dotnetv3/Support/README.md @@ -1,4 +1,4 @@ - + # Support code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with AWS Support. ## ⚠ 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). @@ -61,18 +61,20 @@ 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 cases](Scenarios/SupportCaseScenario.cs) +* [Get started with cases](Scenarios/SupportCaseScenario.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: @@ -80,8 +82,8 @@ 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. diff --git a/dotnetv3/Transcribe/README.md b/dotnetv3/Transcribe/README.md index a2f87586aa2..cda34b3bfaa 100644 --- a/dotnetv3/Transcribe/README.md +++ b/dotnetv3/Transcribe/README.md @@ -1,4 +1,4 @@ - + # Amazon Transcribe code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Transcribe. ## ⚠ 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). @@ -49,11 +49,13 @@ 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: @@ -61,8 +63,8 @@ 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. diff --git a/dotnetv3/Translate/README.md b/dotnetv3/Translate/README.md index 363fce9941d..5964e996a28 100644 --- a/dotnetv3/Translate/README.md +++ b/dotnetv3/Translate/README.md @@ -1,4 +1,4 @@ - + # Amazon Translate code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon Translate. ## ⚠ 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). @@ -44,18 +44,20 @@ Code excerpts that show you how to call individual service functions. Sample applications that work across multiple AWS services. -* [Building an Amazon SNS application](../cross_service/SubscribePublishTranslate) +* [Building an Amazon SNS application](../cross_service/SubscribePublishTranslate) ## 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: @@ -63,8 +65,8 @@ 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. diff --git a/dotnetv3/dynamodb/README.md b/dotnetv3/dynamodb/README.md index 2b7ad367e84..782e81a4389 100644 --- a/dotnetv3/dynamodb/README.md +++ b/dotnetv3/dynamodb/README.md @@ -1,4 +1,4 @@ - + # DynamoDB code examples for the SDK for .NET ## Overview @@ -12,7 +12,7 @@ Shows how to use the AWS SDK for .NET to work with Amazon DynamoDB. ## ⚠ 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). @@ -59,18 +59,18 @@ 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 tables, items, and queries](scenarios/DynamoDB_Basics/DynamoDB_Basics_Scenario/DynamoDB_Basics.cs) -* [Query a table by using batches of PartiQL statements](scenarios/PartiQL_Batch_Scenario/PartiQL_Batch_Scenario/PartiQLBatchMethods.cs) -* [Query a table using PartiQL](scenarios/PartiQL_Basics_Scenario/PartiQL_Basics_Scenario/PartiQLMethods.cs) -* [Use a document model](mid-level-api/MidlevelItemCRUDExample/MidlevelItemCRUDExample/MidlevelItemCRUD.cs) -* [Use a high-level object persistence model](high-level-api/HighLevelItemCRUDExample/HighLevelItemCRUDExample/HighLevelItemCRUD.cs) +* [Get started with tables, items, and queries](scenarios/DynamoDB_Basics/DynamoDB_Basics_Scenario/DynamoDB_Basics.cs) +* [Query a table by using batches of PartiQL statements](scenarios/PartiQL_Batch_Scenario/PartiQL_Batch_Scenario/PartiQLBatchMethods.cs) +* [Query a table using PartiQL](scenarios/PartiQL_Basics_Scenario/PartiQL_Basics_Scenario/PartiQLMethods.cs) +* [Use a document model](mid-level-api/MidlevelItemCRUDExample/MidlevelItemCRUDExample/MidlevelItemCRUD.cs) +* [Use a high-level object persistence model](high-level-api/HighLevelItemCRUDExample/HighLevelItemCRUDExample/HighLevelItemCRUD.cs) ### Cross-service examples Sample applications that work across multiple AWS services. -* [Create a serverless application to manage photos](../cross-service/PhotoAssetManager) -* [Create a web application to track DynamoDB data](../cross-service/DynamoDbItemTracker) +* [Create a serverless application to manage photos](dotnetv3\cross-service\PhotoAssetManager) +* [Create a web application to track DynamoDB data](../cross_service/DynamoDbItemTracker) ## Run the examples