Skip to content

Commit a989b8e

Browse files
committed
Updates to metadata
1 parent 4c47d34 commit a989b8e

File tree

6 files changed

+88
-116
lines changed

6 files changed

+88
-116
lines changed

.doc_gen/metadata/cloudwatch-logs_metadata.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ cloudwatch-logs_GetQueryResults:
290290
languages:
291291
.NET:
292292
versions:
293-
- sdk_version: 3
293+
- sdk_version: 4
294294
github: dotnetv4/CloudWatchLogs/LargeQuery
295295
excerpts:
296296
- description:
@@ -318,7 +318,7 @@ cloudwatch-logs_PutLogEvents:
318318
languages:
319319
.NET:
320320
versions:
321-
- sdk_version: 3
321+
- sdk_version: 4
322322
github: dotnetv4/CloudWatchLogs/LargeQuery
323323
excerpts:
324324
- description:
@@ -330,7 +330,7 @@ cloudwatch-logs_StartQuery:
330330
languages:
331331
.NET:
332332
versions:
333-
- sdk_version: 3
333+
- sdk_version: 4
334334
github: dotnetv4/CloudWatchLogs/LargeQuery
335335
excerpts:
336336
- description:
@@ -362,7 +362,7 @@ cloudwatch-logs_Scenario_BigQuery:
362362
languages:
363363
.NET:
364364
versions:
365-
- sdk_version: 3
365+
- sdk_version: 4
366366
github: dotnetv4/CloudWatchLogs/LargeQuery
367367
excerpts:
368368
- description: This is the main workflow that demonstrates the large query scenario.

.kiro/settings/mcp.json

Lines changed: 0 additions & 54 deletions
This file was deleted.

.kiro/steering/orchestration.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

.tools/readmes/config.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@
129129
"auto-scaling": "dotnetv4/AutoScaling",
130130
"cloudformation": "dotnetv4/CloudFormation",
131131
"cloudwatch": "dotnetv4/CloudWatch",
132+
"cloudwatch-logs": "dotnetv4/CloudWatchLogs",
132133
"cognito-identity-provider": "dotnetv4/Cognito",
133134
"ec2": "dotnetv4/EC2",
134135
"ecs": "dotnetv4/ECS",

dotnetv3/CloudWatchLogs/README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,6 @@ Code excerpts that show you how to call individual service functions.
4141
- [DeleteLogGroup](DeleteLogGroupExample/DeleteLogGroup.cs#L6)
4242
- [DescribeExportTasks](DescribeExportTasksExample/DescribeExportTasks.cs#L6)
4343
- [DescribeLogGroups](DescribeLogGroupsExample/DescribeLogGroups.cs#L6)
44-
- [GetQueryResults](../../dotnetv4/CloudWatchLogs/LargeQuery/Actions/CloudWatchLogsWrapper.cs#L79)
45-
- [PutLogEvents](../../dotnetv4/CloudWatchLogs/LargeQuery/Actions/CloudWatchLogsWrapper.cs#L110)
46-
- [StartQuery](../../dotnetv4/CloudWatchLogs/LargeQuery/Actions/CloudWatchLogsWrapper.cs#L30)
47-
48-
### Scenarios
49-
50-
Code examples that show you how to accomplish a specific task by calling multiple
51-
functions within the same service.
52-
53-
- [Run a large query](../../dotnetv4/CloudWatchLogs/LargeQuery/Scenarios/LargeQueryWorkflow.cs)
5444

5545

5646
<!--custom.examples.start-->
@@ -83,18 +73,6 @@ Alternatively, you can run the example from within your IDE.
8373

8474

8575

86-
#### Run a large query
87-
88-
This example shows you how to use CloudWatch Logs to query more than 10,000 records.
89-
90-
91-
<!--custom.scenario_prereqs.cloudwatch-logs_Scenario_BigQuery.start-->
92-
<!--custom.scenario_prereqs.cloudwatch-logs_Scenario_BigQuery.end-->
93-
94-
95-
<!--custom.scenarios.cloudwatch-logs_Scenario_BigQuery.start-->
96-
<!--custom.scenarios.cloudwatch-logs_Scenario_BigQuery.end-->
97-
9876
### Tests
9977

10078
⚠ Running tests might result in charges to your AWS account.

dotnetv4/CloudWatchLogs/README.md

Lines changed: 83 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,99 @@
1-
# CloudWatch Logs Examples for .NET
1+
# CloudWatch Logs code examples for the SDK for .NET (v4)
22

3-
This folder contains examples for Amazon CloudWatch Logs using the AWS SDK for .NET.
3+
## Overview
44

5-
## Examples
5+
Shows how to use the AWS SDK for .NET (v4) to work with Amazon CloudWatch Logs.
66

7-
### Feature Scenarios
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
89

9-
- **[LargeQuery](LargeQuery/)** - Demonstrates how to perform large-scale queries on CloudWatch Logs using recursive binary search to retrieve more than the 10,000 result limit.
10+
_CloudWatch Logs monitor, store, and access your log files from Amazon Elastic Compute Cloud instances, AWS CloudTrail, or other sources._
1011

11-
## Running the Examples
12+
## ⚠ Important
1213

13-
Each example includes its own README with specific instructions. Generally, you can:
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* 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).
17+
* 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).
1418

15-
1. Navigate to the example directory
16-
2. Build the solution: `dotnet build`
17-
3. Run the example: `dotnet run --project Scenarios/{ProjectName}.csproj`
18-
4. Run tests: `dotnet test`
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
1921

20-
## Prerequisites
22+
## Code examples
2123

22-
- .NET 8.0 or later
23-
- AWS credentials configured
24-
- Appropriate AWS permissions for CloudWatch Logs
24+
### Prerequisites
2525

26-
## Additional Resources
26+
For prerequisites, see the [README](../README.md#Prerequisites) in the `dotnetv4` folder.
2727

28-
- [CloudWatch Logs Documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/)
29-
- [AWS SDK for .NET Documentation](https://docs.aws.amazon.com/sdk-for-net/)
30-
- [CloudWatch Logs API Reference](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/)
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
32+
### Single actions
33+
34+
Code excerpts that show you how to call individual service functions.
35+
36+
- [GetQueryResults](LargeQuery/Actions/CloudWatchLogsWrapper.cs#L79)
37+
- [PutLogEvents](LargeQuery/Actions/CloudWatchLogsWrapper.cs#L110)
38+
- [StartQuery](LargeQuery/Actions/CloudWatchLogsWrapper.cs#L30)
39+
40+
### Scenarios
41+
42+
Code examples that show you how to accomplish a specific task by calling multiple
43+
functions within the same service.
44+
45+
- [Run a large query](LargeQuery/Scenarios/LargeQueryWorkflow.cs)
46+
47+
48+
<!--custom.examples.start-->
49+
<!--custom.examples.end-->
50+
51+
## Run the examples
52+
53+
### Instructions
54+
55+
56+
<!--custom.instructions.start-->
57+
<!--custom.instructions.end-->
58+
59+
60+
61+
#### Run a large query
62+
63+
This example shows you how to use CloudWatch Logs to query more than 10,000 records.
64+
65+
66+
<!--custom.scenario_prereqs.cloudwatch-logs_Scenario_BigQuery.start-->
67+
<!--custom.scenario_prereqs.cloudwatch-logs_Scenario_BigQuery.end-->
68+
69+
70+
<!--custom.scenarios.cloudwatch-logs_Scenario_BigQuery.start-->
71+
<!--custom.scenarios.cloudwatch-logs_Scenario_BigQuery.end-->
72+
73+
### Tests
74+
75+
⚠ Running tests might result in charges to your AWS account.
76+
77+
78+
To find instructions for running these tests, see the [README](../README.md#Tests)
79+
in the `dotnetv4` folder.
80+
81+
82+
83+
<!--custom.tests.start-->
84+
<!--custom.tests.end-->
85+
86+
## Additional resources
87+
88+
- [CloudWatch Logs User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html)
89+
- [CloudWatch Logs API Reference](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/Welcome.html)
90+
- [SDK for .NET (v4) CloudWatch Logs reference](https://docs.aws.amazon.com/sdkfornet/v4/apidocs/items/Cloudwatch-logs/NCloudwatch-logs.html)
91+
92+
<!--custom.resources.start-->
93+
<!--custom.resources.end-->
3194

3295
---
3396

3497
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
98+
3599
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)