Skip to content

Commit

Permalink
feat(client-cloudwatch-logs): This release adds a new field, logGroup…
Browse files Browse the repository at this point in the history 
…Arn, to the response of the logs:DescribeLogGroups action.
  • Loading branch information
awstools committed Feb 6, 2024
1 parent 6581c52 commit 2bb3dc6
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 10 deletions.
4 changes: 4 additions & 0 deletions clients/client-cloudwatch-logs/src/commands/CreateLogGroupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ export interface CreateLogGroupCommandOutput extends __MetadataBearer {}
* <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen),
* '/' (forward slash), '.' (period), and '#' (number sign)</p>
* </li>
* <li>
* <p>Log group names can't start with the string <code>aws/</code>
* </p>
* </li>
* </ul>
* <p>When you create a log group, by default the log events in the log group do not expire.
* To set a retention policy so that events expire and are deleted after a specified time, use
Expand Down
13 changes: 13 additions & 0 deletions clients/client-cloudwatch-logs/src/commands/DescribeDeliveriesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,19 @@ export interface DescribeDeliveriesCommandOutput extends DescribeDeliveriesRespo
/**
* @public
* <p>Retrieves a list of the deliveries that have been created in the account.</p>
* <p>A <i>delivery</i> is a
* connection between a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">
* <i>delivery source</i>
* </a> and a
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">
* <i>delivery destination</i>
* </a>.</p>
* <p>A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination.
* The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
* in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enable logging from Amazon Web Services
* services.</a>
* </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
1 change: 1 addition & 0 deletions clients/client-cloudwatch-logs/src/commands/DescribeLogGroupsCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ export interface DescribeLogGroupsCommandOutput extends DescribeLogGroupsRespons
* // "ACCOUNT_DATA_PROTECTION",
* // ],
* // logGroupClass: "STANDARD" || "INFREQUENT_ACCESS",
* // logGroupArn: "STRING_VALUE",
* // },
* // ],
* // nextToken: "STRING_VALUE",
Expand Down
14 changes: 12 additions & 2 deletions clients/client-cloudwatch-logs/src/commands/GetDeliveryCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,18 @@ export interface GetDeliveryCommandOutput extends GetDeliveryResponse, __Metadat

/**
* @public
* <p>Returns complete information about one <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
* <i>delivery destination</i>
* <p>Returns complete information about one logical <i>delivery</i>. A delivery is a
* connection between a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">
* <i>delivery source</i>
* </a> and a
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">
* <i>delivery destination</i>
* </a>.</p>
* <p>A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination.
* The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.
* Only some Amazon Web Services services support being configured as a delivery source. These services are listed
* in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enable logging from Amazon Web Services
* services.</a>
* </p>
* <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
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation.</p>
Expand Down
28 changes: 25 additions & 3 deletions clients/client-cloudwatch-logs/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1958,7 +1958,10 @@ export interface LogGroup {

/**
* @public
* <p>The Amazon Resource Name (ARN) of the log group.</p>
* <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>
* <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
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>.
* The permissions for those three actions require the ARN version that doesn't include a trailing <code>:*</code>.</p>
*/
arn?: string;

Expand Down Expand Up @@ -2006,6 +2009,25 @@ export interface LogGroup {
* </p>
*/
logGroupClass?: LogGroupClass;

/**
* @public
* <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>
* <p>Use this version to refer to the ARN in the following situations:</p>
* <ul>
* <li>
* <p>In the <code>logGroupIdentifier</code> input field in many CloudWatch Logs APIs.</p>
* </li>
* <li>
* <p>In the <code>resourceArn</code> field in tagging APIs</p>
* </li>
* <li>
* <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
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>.</p>
* </li>
* </ul>
*/
logGroupArn?: string;
}

/**
Expand Down Expand Up @@ -4179,8 +4201,8 @@ export interface PutDeliverySourceRequest {

/**
* @public
* <p>Defines the type of log that the source is sending. For valid values for this parameter, see the documentation for
* the source service.</p>
* <p>Defines the type of log that the source is sending. For Amazon CodeWhisperer, the valid value is
* <code>EVENT_LOGS</code>.</p>
*/
logType: string | undefined;

Expand Down
16 changes: 11 additions & 5 deletions codegen/sdk-codegen/aws-models/cloudwatch-logs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@
}
],
"traits": {
"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>"
"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>"
}
},
"com.amazonaws.cloudwatchlogs#CreateLogGroupRequest": {
Expand Down Expand Up @@ -1980,7 +1980,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of the deliveries that have been created in the account.</p>",
"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>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
Expand Down Expand Up @@ -3618,7 +3618,7 @@
}
],
"traits": {
"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>"
"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>"
}
},
"com.amazonaws.cloudwatchlogs#GetDeliveryDestination": {
Expand Down Expand Up @@ -4826,7 +4826,7 @@
"arn": {
"target": "com.amazonaws.cloudwatchlogs#Arn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the log group.</p>"
"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>"
}
},
"storedBytes": {
Expand Down Expand Up @@ -4858,6 +4858,12 @@
"traits": {
"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>"
}
},
"logGroupArn": {
"target": "com.amazonaws.cloudwatchlogs#Arn",
"traits": {
"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>"
}
}
},
"traits": {
Expand Down Expand Up @@ -7119,7 +7125,7 @@
"logType": {
"target": "com.amazonaws.cloudwatchlogs#LogType",
"traits": {
"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>",
"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>",
"smithy.api#required": {}
}
},
Expand Down

0 comments on commit 2bb3dc6

Please sign in to comment.