Skip to content

Commit edf484b

Browse files
Documentation-only update to address doc errors
1 parent fc94637 commit edf484b

21 files changed

+717
-163
lines changed

generator/ServiceModels/logs/logs-2014-03-28.docs.json

Lines changed: 14 additions & 14 deletions
Large diffs are not rendered by default.

generator/ServiceModels/logs/logs-2014-03-28.normal.json

Lines changed: 14 additions & 14 deletions
Large diffs are not rendered by default.

sdk/src/Services/CloudWatchLogs/Generated/Model/AssociateKmsKeyRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ namespace Amazon.CloudWatchLogs.Model
4242
/// </para>
4343
/// <ul> <li>
4444
/// <para>
45-
/// Specify the <c>logGroupName</c> parameter to cause all log events stored in the log
45+
/// Specify the <c>logGroupName</c> parameter to cause log events ingested into that log
4646
/// group to be encrypted with that key. Only the log events ingested after the key is
4747
/// associated are encrypted with that key.
4848
/// </para>

sdk/src/Services/CloudWatchLogs/Generated/Model/CreateExportTaskRequest.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,13 @@ namespace Amazon.CloudWatchLogs.Model
6262
/// </para>
6363
/// <note>
6464
/// <para>
65+
/// We recommend that you don't regularly export to Amazon S3 as a way to continuously
66+
/// archive your logs. For that use case, we instaed recommend that you use subscriptions.
67+
/// For more information about subscriptions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions.html">Real-time
68+
/// processing of log data with subscriptions</a>.
69+
/// </para>
70+
/// </note> <note>
71+
/// <para>
6572
/// Time-based sorting on chunks of log data inside an exported file is not guaranteed.
6673
/// You can sort the exported log field data by using Linux utilities.
6774
/// </para>

sdk/src/Services/CloudWatchLogs/Generated/Model/DeleteDeliveryRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ namespace Amazon.CloudWatchLogs.Model
3131
{
3232
/// <summary>
3333
/// Container for the parameters to the DeleteDelivery operation.
34-
/// Deletes s <i>delivery</i>. A delivery is a connection between a logical <i>delivery
34+
/// Deletes a <i>delivery</i>. A delivery is a connection between a logical <i>delivery
3535
/// source</i> and a logical <i>delivery destination</i>. Deleting a delivery only deletes
3636
/// the connection between the delivery source and delivery destination. It does not delete
3737
/// the delivery destination or the delivery source.

sdk/src/Services/CloudWatchLogs/Generated/Model/DescribeAccountPoliciesRequest.cs

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,33 @@ namespace Amazon.CloudWatchLogs.Model
3232
/// <summary>
3333
/// Container for the parameters to the DescribeAccountPolicies operation.
3434
/// Returns a list of all CloudWatch Logs account policies in the account.
35+
///
36+
///
37+
/// <para>
38+
/// To use this operation, you must be signed on with the correct permissions depending
39+
/// on the type of policy that you are retrieving information for.
40+
/// </para>
41+
/// <ul> <li>
42+
/// <para>
43+
/// To see data protection policies, you must have the <c>logs:GetDataProtectionPolicy</c>
44+
/// and <c>logs:DescribeAccountPolicies</c> permissions.
45+
/// </para>
46+
/// </li> <li>
47+
/// <para>
48+
/// To see subscription filter policies, you must have the <c>logs:DescrubeSubscriptionFilters</c>
49+
/// and <c>logs:DescribeAccountPolicies</c> permissions.
50+
/// </para>
51+
/// </li> <li>
52+
/// <para>
53+
/// To see transformer policies, you must have the <c>logs:GetTransformer</c> and <c>logs:DescribeAccountPolicies</c>
54+
/// permissions.
55+
/// </para>
56+
/// </li> <li>
57+
/// <para>
58+
/// To see field index policies, you must have the <c>logs:DescribeIndexPolicies</c> and
59+
/// <c>logs:DescribeAccountPolicies</c> permissions.
60+
/// </para>
61+
/// </li> </ul>
3562
/// </summary>
3663
public partial class DescribeAccountPoliciesRequest : AmazonCloudWatchLogsRequest
3764
{

sdk/src/Services/CloudWatchLogs/Generated/Model/DescribeLogStreamsRequest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ namespace Amazon.CloudWatchLogs.Model
4242
/// </para>
4343
///
4444
/// <para>
45-
/// This operation has a limit of five transactions per second, after which transactions
45+
/// This operation has a limit of 25 transactions per second, after which transactions
4646
/// are throttled.
4747
/// </para>
4848
///

sdk/src/Services/CloudWatchLogs/Generated/Model/OpenSearchResourceConfig.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,9 @@ internal bool IsSetApplicationArn()
6969
/// </para>
7070
/// <important>
7171
/// <para>
72-
/// In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardsAccess</b>
73-
/// IAM policy. For more information, see
72+
/// In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardAccess</b>
73+
/// IAM policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-UserRoles.html">IAM
74+
/// policies for users</a>.
7475
/// </para>
7576
/// </important>
7677
/// </summary>
@@ -93,9 +94,8 @@ internal bool IsSetDashboardViewerPrincipals()
9394
/// Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration.
9495
/// This role must have the permissions necessary to access the OpenSearch Service collection
9596
/// to be able to create the dashboards. For more information about the permissions needed,
96-
/// see <a href="https://docs.aws.amazon.com/OpenSearch-Dashboards-CreateRole">Create
97-
/// an IAM role to access the OpenSearch Service collection</a> in the CloudWatch Logs
98-
/// User Guide.
97+
/// see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-CreateRole.html">Permissions
98+
/// that the integration needs</a> in the CloudWatch Logs User Guide.
9999
/// </para>
100100
/// </summary>
101101
[AWSProperty(Required=true)]

sdk/src/Services/CloudWatchLogs/Generated/Model/PutAccountPolicyRequest.cs

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,31 @@ namespace Amazon.CloudWatchLogs.Model
3636
///
3737
///
3838
/// <para>
39+
/// To use this operation, you must be signed on with the correct permissions depending
40+
/// on the type of policy that you are creating.
41+
/// </para>
42+
/// <ul> <li>
43+
/// <para>
44+
/// To create a data protection policy, you must have the <c>logs:PutDataProtectionPolicy</c>
45+
/// and <c>logs:PutAccountPolicy</c> permissions.
46+
/// </para>
47+
/// </li> <li>
48+
/// <para>
49+
/// To create a subscription filter policy, you must have the <c>logs:PutSubscriptionFilter</c>
50+
/// and <c>logs:PutccountPolicy</c> permissions.
51+
/// </para>
52+
/// </li> <li>
53+
/// <para>
54+
/// To create a transformer policy, you must have the <c>logs:PutTransformer</c> and <c>logs:PutAccountPolicy</c>
55+
/// permissions.
56+
/// </para>
57+
/// </li> <li>
58+
/// <para>
59+
/// To create a field index policy, you must have the <c>logs:PutIndexPolicy</c> and <c>logs:PutAccountPolicy</c>
60+
/// permissions.
61+
/// </para>
62+
/// </li> </ul>
63+
/// <para>
3964
/// <b>Data protection policy</b>
4065
/// </para>
4166
///

sdk/src/Services/CloudWatchLogs/Generated/Model/PutDeliveryDestinationRequest.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@ namespace Amazon.CloudWatchLogs.Model
4848
/// </para>
4949
/// </li> <li>
5050
/// <para>
51-
/// Use <c>PutDeliveryDestination</c> to create a <i>delivery destination</i>, which is
52-
/// a logical object that represents the actual delivery destination.
51+
/// Use <c>PutDeliveryDestination</c> to create a <i>delivery destination</i> in the same
52+
/// account of the actual delivery destination. The delivery destination that you create
53+
/// is a logical object that represents the actual delivery destination.
5354
/// </para>
5455
/// </li> <li>
5556
/// <para>

0 commit comments

Comments
 (0)