Skip to content

Commit

Permalink
Fixes for metadata and typos and spacing.
Browse files Browse the repository at this point in the history
Fixes for metadata and typos and spacing.
  • Loading branch information
rlhagerm committed Sep 20, 2022
1 parent d52a2bb commit 6a4f27e
Show file tree
Hide file tree
Showing 15 changed files with 39 additions and 33 deletions.
4 changes: 2 additions & 2 deletions .doc_gen/metadata/ec2_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ ec2_CreateVpc:
snippet_tags:
- EC2.dotnetv3.CreateVPCExample
services:
ec2: {CreateVPC}
ec2: {CreateVpc}
ec2_StartInstances:
title: Start an &EC2; instance using an &AWS; SDK
title_abbrev: Start an instance
Expand Down Expand Up @@ -602,4 +602,4 @@ ec2_DeleteVPC:
snippet_tags:
- EC2.dotnetv3.DeleteVPCExample
services:
ec2: {DeleteVPC}
ec2: {DeleteVpc}
8 changes: 4 additions & 4 deletions .doc_gen/metadata/kinesis_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ kinesis_DeregisterConsumer:
snippet_tags:
- Kinesis.dotnetv3.DeregisterConsumerExample
services:
kinesis: {DeregisterConsumer}
kinesis: {DeregisterStreamConsumer}
kinesis_DescribeStream:
title: Describe a &AK; stream using an &AWS; SDK
title_abbrev: Describe a stream
Expand Down Expand Up @@ -102,7 +102,7 @@ kinesis_ListConsumers:
snippet_tags:
- Kinesis.dotnetv3.ListConsumersExample
services:
kinesis: {ListConsumers}
kinesis: {ListStreamConsumers}
kinesis_ListStreams:
title: List &AK; streams using an &AWS; SDK
title_abbrev: List streams
Expand Down Expand Up @@ -144,7 +144,7 @@ kinesis_ListTags:
snippet_tags:
- Kinesis.dotnetv3.ListTagsExample
services:
kinesis: {ListTags}
kinesis: {ListTagsForStream}
kinesis_DeleteStream:
title: Delete a &AK; stream using an &AWS; SDK
title_abbrev: Delete a stream
Expand Down Expand Up @@ -267,7 +267,7 @@ kinesis_RegisterConsumer:
snippet_tags:
- Kinesis.dotnetv3.RegisterConsumerExample
services:
kinesis: { RegisterConsumer }
kinesis: { RegisterStreamConsumer }
kinesis_TagStream:
title: Add tags to a &AK; stream using an &AWS; SDK
title_abbrev: Add tags
Expand Down
2 changes: 1 addition & 1 deletion .doc_gen/metadata/translate_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ translate_DescribeTranslationJob:
snippet_tags:
- Translate.dotnetv3.DescribeTextTranslationJobExample
services:
translate: {DescribeTranslationJob}
translate: {DescribeTextTranslationJob}
translate_ListTranslationJobs:
title: List the &TSL; translation jobs using an &AWS; SDK
title_abbrev: List translation jobs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ static void Main(string[] args)
var describeCertificateReq = new DescribeCertificateRequest();
// The ARN used here is just an example. Replace it with the ARN of
// a certificate that exists on your account.
describeCertificateReq.CertificateArn = "arn:aws:acm:us-east-1:123456789012:certificate/8cfd7dae-9b6a-2d07-92bc-1c3093edb218";
describeCertificateReq.CertificateArn =
"arn:aws:acm:us-east-1:123456789012:certificate/8cfd7dae-9b6a-2d07-92bc-1c309EXAMPLE";

var certificateDetailResp = DescribeCertificateResponseAsync(client: _client, request: describeCertificateReq);
var certificateDetailResp =
DescribeCertificateResponseAsync(client: _client, request: describeCertificateReq);
var certificateDetail = certificateDetailResp.Result.Certificate;

if (certificateDetail is not null)
Expand Down Expand Up @@ -65,7 +67,8 @@ static void DisplayCertificateDetails(CertificateDetail certificateDetail)
/// <param name="request">The DescribeCertificateRequest object that
/// will be passed to the method call.</param>
/// <returns></returns>
static async Task<DescribeCertificateResponse> DescribeCertificateResponseAsync(AmazonCertificateManagerClient client, DescribeCertificateRequest request)
static async Task<DescribeCertificateResponse> DescribeCertificateResponseAsync(
AmazonCertificateManagerClient client, DescribeCertificateRequest request)
{
var response = new DescribeCertificateResponse();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ static void Main(string[] args)
/// <param name="client">The ACM client object passed to the
/// ListCertificateResAsync method call.</param>
/// <param name="request"></param>
/// <returns></returns>
static async Task<ListCertificatesResponse> ListCertificatesResponseAsync(AmazonCertificateManagerClient client)
/// <returns>The ListCertificatesResponse.</returns>
static async Task<ListCertificatesResponse> ListCertificatesResponseAsync(
AmazonCertificateManagerClient client)
{
var request = new ListCertificatesRequest();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ public static async Task Main()

if (response.HttpStatusCode == System.Net.HttpStatusCode.OK)
{
Console.WriteLine($"The task, {taskName} with ID: {response.TaskId} has been created successfully.");
Console.WriteLine($"The task, {taskName} with ID: " +
$"{response.TaskId} has been created successfully.");
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace DeleteKeyPairExample

/// <summary>
/// Shows how to delete an existing Amazon Elastic Compute Cloud
/// (Amazon EC2) key pair. The example was uses the AWS SDK for .NET
/// (Amazon EC2) key pair. The example uses the AWS SDK for .NET
/// version 3.7 and .NET Core 5.0.
/// </summary>
public class DeleteKeyPair
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace DescribeInstancesExample

/// <summary>
/// This example shows how to list your Amazon Elastic Compute Cloud
/// (Amazon EC2) Instances. It was created using the AWS SDK for .NET
/// (Amazon EC2) instances. It was created using the AWS SDK for .NET
/// version 3.7 and .NET Core 5.0.
/// </summary>
public class DescribeInstances
Expand All @@ -25,13 +25,13 @@ public class DescribeInstances
/// </summary>
public static async Task Main()
{
// If the region of the EC2 Instances you want to list is different
// from the default user's region, you need to specify the rgion
// If the region of the EC2 instances you want to list is different
// from the default user's region, you need to specify the region
// when you create the client object.
// For example: RegionEndpoint.USWest1.
var eC2Client = new AmazonEC2Client();

// List all EC2 Instances.
// List all EC2 instances.
await GetInstanceDescriptions(eC2Client);

string tagName = "IncludeInList";
Expand All @@ -40,7 +40,7 @@ public static async Task Main()
}

/// <summary>
/// This method uses a Paginator to list all of the EC2 Instances
/// This method uses a paginator to list all of the EC2 Instances
/// attached to the default account.
/// </summary>
/// <param name="client">The Amazon EC2 client object used to call
Expand Down Expand Up @@ -76,7 +76,8 @@ public static async Task GetInstanceDescriptions(AmazonEC2Client client)
/// filter on.</param>
/// <param name="tagValue">A string representing the value of the tag
/// to filter on.</param>
public static async Task GetInstanceDescriptionsFiltered(AmazonEC2Client client, string tagName, string tagValue)
public static async Task GetInstanceDescriptionsFiltered(AmazonEC2Client client,
string tagName, string tagValue)
{
// This is the tag we want to use to filter
// the results of our list of instances.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public class RebootInstances
{
/// <summary>
/// Initializes the Amazon EC2 client object and then calls
/// RebootInstancesAsync to reboot the instance(s) in the ectInstanceId
/// RebootInstancesAsync to reboot the instance(s) in the ec2InstanceId
/// list.
/// </summary>
public static async Task Main()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ public static async Task Main()
var client = new AmazonEC2Client();

// In addition to the list of instance Ids, the
// request can als include the following properties:
// request can also include the following properties:
// Force When true forces the instances to
// stop but you have to check the integrity
// of the file system. (Not recommended on
// of the file system. Not recommended on
// Windows instances.
// Hibernate When true, hibernates the instance if the
// instance was enabled for hibernation when
Expand All @@ -50,7 +50,8 @@ public static async Task Main()
var instances = response.StoppingInstances;
instances.ForEach(i =>
{
Console.WriteLine($"Successfully stopped the EC2 Instance with InstanceID: {i.InstanceId}.");
Console.WriteLine($"Successfully stopped the EC2 Instance " +
$"with InstanceID: {i.InstanceId}.");
});
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ namespace AttachPolicyExample
using Amazon.Organizations.Model;

/// <summary>
/// Shows how to attach an AWS Organizations Policy to an Organization,
/// an Organizational Unit, or an Account.
/// Shows how to attach an AWS Organizations policy to an organization,
/// an organizational unit, or an account.
/// </summary>
public class AttachPolicy
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ namespace CreateOrganizationExample
using Amazon.Organizations.Model;

/// <summary>
/// Creates an AWS Organizations organization. The example was created
/// Creates an organization in AWS Organizations. The example was created
/// using the AWS SDK for .NET version 3.7 and .NET Core 5.0.
/// </summary>
public class CreateOrganization
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ namespace CreateOrganizationalUnitExample
using Amazon.Organizations.Model;

/// <summary>
/// Creates a new AWS Organizations Organizational Unit. The example was
/// Creates a new organizational unit in AWS Organizations. The example was
/// created using the AWS SDK for .NET version 3.7 and .NET Core 5.0.
/// </summary>
public class CreateOrganizationalUnit
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ namespace CreatePolicyExample
class CreatePolicy
{
/// <summary>
/// Initializes the AWS Organizations client object uses it to
/// Initializes the AWS Organizations client object, uses it to
/// create a new Organizations Policy, and then displays information
/// about the newly created Policy.
/// </summary>
Expand All @@ -37,7 +37,7 @@ static async Task Main()
var response = await client.CreatePolicyAsync(new CreatePolicyRequest
{
Content = policyContent,
Description = "Enables admins of attached accounts to delegate all S3 permissions",
Description = "Enables admins of attached accounts to delegate all Amazon S3 permissions",
Name = "AllowAllS3Actions",
Type = "SERVICE_CONTROL_POLICY",
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,15 @@ namespace DeletePolicyExample
using Amazon.Organizations.Model;

/// <summary>
/// Deletes an existing Amazon Orgranizations Policy. This example was
/// Deletes an existing Amazon Organizations policy. This example was
/// created using the AWS SDK for .NET version 3.7 and .NET Core 5.0.
/// </summary>
public class DeletePolicy
{
/// <summary>
/// Initializes the Organizations client object and then uses it to
/// delete the Policy with the specified Policy Id.
/// delete the policy with the specified policyId.
/// </summary>
/// <returns></returns>
public static async Task Main()
{
// Create the client object using the default account.
Expand Down

0 comments on commit 6a4f27e

Please sign in to comment.