Skip to content

Commit 2bb3dc6

Browse files
author
awstools
committed
feat(client-cloudwatch-logs): This release adds a new field, logGroupArn, to the response of the logs:DescribeLogGroups action.
1 parent 6581c52 commit 2bb3dc6

File tree

6 files changed

+66
-10
lines changed

6 files changed

+66
-10
lines changed

clients/client-cloudwatch-logs/src/commands/CreateLogGroupCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ export interface CreateLogGroupCommandOutput extends __MetadataBearer {}
4242
* <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen),
4343
* '/' (forward slash), '.' (period), and '#' (number sign)</p>
4444
* </li>
45+
* <li>
46+
* <p>Log group names can't start with the string <code>aws/</code>
47+
* </p>
48+
* </li>
4549
* </ul>
4650
* <p>When you create a log group, by default the log events in the log group do not expire.
4751
* To set a retention policy so that events expire and are deleted after a specified time, use

clients/client-cloudwatch-logs/src/commands/DescribeDeliveriesCommand.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,19 @@ export interface DescribeDeliveriesCommandOutput extends DescribeDeliveriesRespo
2929
/**
3030
* @public
3131
* <p>Retrieves a list of the deliveries that have been created in the account.</p>
32+
* <p>A <i>delivery</i> is a
33+
* connection between a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">
34+
* <i>delivery source</i>
35+
* </a> and a
36+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">
37+
* <i>delivery destination</i>
38+
* </a>.</p>
39+
* <p>A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination.
40+
* The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
41+
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
42+
* in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enable logging from Amazon Web Services
43+
* services.</a>
44+
* </p>
3245
* @example
3346
* Use a bare-bones client and the command you need to make an API call.
3447
* ```javascript

clients/client-cloudwatch-logs/src/commands/DescribeLogGroupsCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ export interface DescribeLogGroupsCommandOutput extends DescribeLogGroupsRespons
7474
* // "ACCOUNT_DATA_PROTECTION",
7575
* // ],
7676
* // logGroupClass: "STANDARD" || "INFREQUENT_ACCESS",
77+
* // logGroupArn: "STRING_VALUE",
7778
* // },
7879
* // ],
7980
* // nextToken: "STRING_VALUE",

clients/client-cloudwatch-logs/src/commands/GetDeliveryCommand.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,18 @@ export interface GetDeliveryCommandOutput extends GetDeliveryResponse, __Metadat
2828

2929
/**
3030
* @public
31-
* <p>Returns complete information about one <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
32-
* <i>delivery destination</i>
31+
* <p>Returns complete information about one logical <i>delivery</i>. A delivery is a
32+
* connection between a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">
33+
* <i>delivery source</i>
34+
* </a> and a
35+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">
36+
* <i>delivery destination</i>
37+
* </a>.</p>
38+
* <p>A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination.
39+
* The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
40+
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
41+
* in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enable logging from Amazon Web Services
42+
* services.</a>
3343
* </p>
3444
* <p>You need to specify the delivery <code>id</code> in this operation. You can find the IDs of the deliveries in your account with the
3545
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation.</p>

clients/client-cloudwatch-logs/src/models/models_0.ts

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1958,7 +1958,10 @@ export interface LogGroup {
19581958

19591959
/**
19601960
* @public
1961-
* <p>The Amazon Resource Name (ARN) of the log group.</p>
1961+
* <p>The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing <code>:*</code> after the log group name. </p>
1962+
* <p>Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>, and
1963+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>.
1964+
* The permissions for those three actions require the ARN version that doesn't include a trailing <code>:*</code>.</p>
19621965
*/
19631966
arn?: string;
19641967

@@ -2006,6 +2009,25 @@ export interface LogGroup {
20062009
* </p>
20072010
*/
20082011
logGroupClass?: LogGroupClass;
2012+
2013+
/**
2014+
* @public
2015+
* <p>The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing <code>:*</code> after the log group name. </p>
2016+
* <p>Use this version to refer to the ARN in the following situations:</p>
2017+
* <ul>
2018+
* <li>
2019+
* <p>In the <code>logGroupIdentifier</code> input field in many CloudWatch Logs APIs.</p>
2020+
* </li>
2021+
* <li>
2022+
* <p>In the <code>resourceArn</code> field in tagging APIs</p>
2023+
* </li>
2024+
* <li>
2025+
* <p>In IAM policies, when specifying permissions for <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>, and
2026+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>.</p>
2027+
* </li>
2028+
* </ul>
2029+
*/
2030+
logGroupArn?: string;
20092031
}
20102032

20112033
/**
@@ -4179,8 +4201,8 @@ export interface PutDeliverySourceRequest {
41794201

41804202
/**
41814203
* @public
4182-
* <p>Defines the type of log that the source is sending. For valid values for this parameter, see the documentation for
4183-
* the source service.</p>
4204+
* <p>Defines the type of log that the source is sending. For Amazon CodeWhisperer, the valid value is
4205+
* <code>EVENT_LOGS</code>.</p>
41844206
*/
41854207
logType: string | undefined;
41864208

codegen/sdk-codegen/aws-models/cloudwatch-logs.json

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -851,7 +851,7 @@
851851
}
852852
],
853853
"traits": {
854-
"smithy.api#documentation": "<p>Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.</p>\n <p>You must use the following guidelines when naming a log group:</p>\n <ul>\n <li>\n <p>Log group names must be unique within a Region for an Amazon Web Services\n account.</p>\n </li>\n <li>\n <p>Log group names can be between 1 and 512 characters long.</p>\n </li>\n <li>\n <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)</p>\n </li>\n </ul>\n <p>When you create a log group, by default the log events in the log group do not expire.\n To set a retention policy so that events expire and are deleted after a specified time, use\n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html\">PutRetentionPolicy</a>.</p>\n <p>If you associate an KMS key with the log group, ingested data is\n encrypted using the KMS key. This association is stored as long as the data\n encrypted with the KMS key is still within CloudWatch Logs. This enables\n CloudWatch Logs to decrypt this data whenever it is requested.</p>\n <p>If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an\n <code>InvalidParameterException</code> error. </p>\n <important>\n <p>CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using\n Symmetric and Asymmetric Keys</a>.</p>\n </important>"
854+
"smithy.api#documentation": "<p>Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.</p>\n <p>You must use the following guidelines when naming a log group:</p>\n <ul>\n <li>\n <p>Log group names must be unique within a Region for an Amazon Web Services\n account.</p>\n </li>\n <li>\n <p>Log group names can be between 1 and 512 characters long.</p>\n </li>\n <li>\n <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)</p>\n </li>\n <li>\n <p>Log group names can't start with the string <code>aws/</code>\n </p>\n </li>\n </ul>\n <p>When you create a log group, by default the log events in the log group do not expire.\n To set a retention policy so that events expire and are deleted after a specified time, use\n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html\">PutRetentionPolicy</a>.</p>\n <p>If you associate an KMS key with the log group, ingested data is\n encrypted using the KMS key. This association is stored as long as the data\n encrypted with the KMS key is still within CloudWatch Logs. This enables\n CloudWatch Logs to decrypt this data whenever it is requested.</p>\n <p>If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an\n <code>InvalidParameterException</code> error. </p>\n <important>\n <p>CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using\n Symmetric and Asymmetric Keys</a>.</p>\n </important>"
855855
}
856856
},
857857
"com.amazonaws.cloudwatchlogs#CreateLogGroupRequest": {
@@ -1980,7 +1980,7 @@
19801980
}
19811981
],
19821982
"traits": {
1983-
"smithy.api#documentation": "<p>Retrieves a list of the deliveries that have been created in the account.</p>",
1983+
"smithy.api#documentation": "<p>Retrieves a list of the deliveries that have been created in the account.</p>\n <p>A <i>delivery</i> is a \n connection between a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html\">\n <i>delivery source</i>\n </a> and a \n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html\">\n <i>delivery destination</i>\n </a>.</p>\n <p>A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. \n The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose. \n Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n in <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html\">Enable logging from Amazon Web Services \n services.</a>\n </p>",
19841984
"smithy.api#paginated": {
19851985
"inputToken": "nextToken",
19861986
"outputToken": "nextToken",
@@ -3618,7 +3618,7 @@
36183618
}
36193619
],
36203620
"traits": {
3621-
"smithy.api#documentation": "<p>Returns complete information about one <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical\n <i>delivery destination</i>\n </p>\n <p>You need to specify the delivery <code>id</code> in this operation. You can find the IDs of the deliveries in your account with the \n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html\">DescribeDeliveries</a> operation.</p>"
3621+
"smithy.api#documentation": "<p>Returns complete information about one logical <i>delivery</i>. A delivery is a \n connection between a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html\">\n <i>delivery source</i>\n </a> and a \n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html\">\n <i>delivery destination</i>\n </a>.</p>\n <p>A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. \n The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose. \n Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n in <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html\">Enable logging from Amazon Web Services \n services.</a>\n </p>\n <p>You need to specify the delivery <code>id</code> in this operation. You can find the IDs of the deliveries in your account with the \n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html\">DescribeDeliveries</a> operation.</p>"
36223622
}
36233623
},
36243624
"com.amazonaws.cloudwatchlogs#GetDeliveryDestination": {
@@ -4826,7 +4826,7 @@
48264826
"arn": {
48274827
"target": "com.amazonaws.cloudwatchlogs#Arn",
48284828
"traits": {
4829-
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the log group.</p>"
4829+
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing <code>:*</code> after the log group name. </p>\n <p>Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html\">TagResource</a>, <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html\">UntagResource</a>, and \n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html\">ListTagsForResource</a>. \n The permissions for those three actions require the ARN version that doesn't include a trailing <code>:*</code>.</p>"
48304830
}
48314831
},
48324832
"storedBytes": {
@@ -4858,6 +4858,12 @@
48584858
"traits": {
48594859
"smithy.api#documentation": "<p>This specifies the log group class for this log group. There are two classes:</p>\n <ul>\n <li>\n <p>The <code>Standard</code> log class supports all CloudWatch Logs features.</p>\n </li>\n <li>\n <p>The <code>Infrequent Access</code> log class supports a subset of CloudWatch Logs features\n and incurs lower costs.</p>\n </li>\n </ul>\n <p>For details about the features supported by each class, see \n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html\">Log classes</a>\n </p>"
48604860
}
4861+
},
4862+
"logGroupArn": {
4863+
"target": "com.amazonaws.cloudwatchlogs#Arn",
4864+
"traits": {
4865+
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing <code>:*</code> after the log group name. </p>\n <p>Use this version to refer to the ARN in the following situations:</p>\n <ul>\n <li>\n <p>In the <code>logGroupIdentifier</code> input field in many CloudWatch Logs APIs.</p>\n </li>\n <li>\n <p>In the <code>resourceArn</code> field in tagging APIs</p>\n </li>\n <li>\n <p>In IAM policies, when specifying permissions for <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html\">TagResource</a>, <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html\">UntagResource</a>, and \n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html\">ListTagsForResource</a>.</p>\n </li>\n </ul>"
4866+
}
48614867
}
48624868
},
48634869
"traits": {
@@ -7119,7 +7125,7 @@
71197125
"logType": {
71207126
"target": "com.amazonaws.cloudwatchlogs#LogType",
71217127
"traits": {
7122-
"smithy.api#documentation": "<p>Defines the type of log that the source is sending. For valid values for this parameter, see the documentation for\n the source service.</p>",
7128+
"smithy.api#documentation": "<p>Defines the type of log that the source is sending. For Amazon CodeWhisperer, the valid value is \n <code>EVENT_LOGS</code>.</p>",
71237129
"smithy.api#required": {}
71247130
}
71257131
},

0 commit comments

Comments
 (0)