cdk-docker-image-deployment 0.0.87 → 0.0.88
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +3 -3
- package/lib/destination.js +1 -1
- package/lib/docker-image-deployment.js +1 -1
- package/lib/source.js +1 -1
- package/node_modules/aws-sdk/CHANGELOG.md +23 -1
- package/node_modules/aws-sdk/README.md +29 -1
- package/node_modules/aws-sdk/apis/backup-2018-11-15.min.json +441 -110
- package/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/drs-2020-02-26.min.json +124 -45
- package/node_modules/aws-sdk/apis/ecs-2014-11-13.min.json +331 -215
- package/node_modules/aws-sdk/apis/ecs-2014-11-13.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +252 -214
- package/node_modules/aws-sdk/apis/iot-data-2015-05-28.min.json +26 -0
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.min.json +686 -105
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +43 -8
- package/node_modules/aws-sdk/apis/logs-2014-03-28.min.json +97 -16
- package/node_modules/aws-sdk/apis/metadata.json +3 -0
- package/node_modules/aws-sdk/apis/mgn-2020-02-26.min.json +931 -118
- package/node_modules/aws-sdk/apis/mgn-2020-02-26.paginators.json +24 -0
- package/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json +23 -14
- package/node_modules/aws-sdk/apis/monitoring-2010-08-01.paginators.json +4 -1
- package/node_modules/aws-sdk/apis/oam-2022-06-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/oam-2022-06-10.min.json +482 -0
- package/node_modules/aws-sdk/apis/oam-2022-06-10.paginators.json +22 -0
- package/node_modules/aws-sdk/apis/organizations-2016-11-28.min.json +62 -16
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +379 -236
- package/node_modules/aws-sdk/apis/rds-2014-10-31.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/textract-2018-06-27.min.json +310 -62
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +98 -95
- package/node_modules/aws-sdk/clients/all.d.ts +1 -0
- package/node_modules/aws-sdk/clients/all.js +2 -1
- package/node_modules/aws-sdk/clients/backup.d.ts +405 -15
- package/node_modules/aws-sdk/clients/cloudwatch.d.ts +30 -16
- package/node_modules/aws-sdk/clients/cloudwatchlogs.d.ts +196 -65
- package/node_modules/aws-sdk/clients/drs.d.ts +104 -5
- package/node_modules/aws-sdk/clients/ecs.d.ts +159 -17
- package/node_modules/aws-sdk/clients/efs.d.ts +5 -5
- package/node_modules/aws-sdk/clients/iot.d.ts +76 -4
- package/node_modules/aws-sdk/clients/iotdata.d.ts +31 -1
- package/node_modules/aws-sdk/clients/iotwireless.d.ts +599 -14
- package/node_modules/aws-sdk/clients/kendra.d.ts +84 -39
- package/node_modules/aws-sdk/clients/mgn.d.ts +1046 -68
- package/node_modules/aws-sdk/clients/oam.d.ts +559 -0
- package/node_modules/aws-sdk/clients/oam.js +18 -0
- package/node_modules/aws-sdk/clients/organizations.d.ts +69 -8
- package/node_modules/aws-sdk/clients/rds.d.ts +199 -2
- package/node_modules/aws-sdk/clients/textract.d.ts +264 -0
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +210 -191
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +29 -10
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +91 -33
- package/node_modules/aws-sdk/dist/aws-sdk.js +1167 -707
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +59 -59
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +2 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/event_listeners.js +22 -5
- package/node_modules/aws-sdk/lib/region_config.js +3 -1
- package/node_modules/aws-sdk/lib/region_config_data.json +11 -1
- package/node_modules/aws-sdk/lib/signers/bearer.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +6 -5
|
@@ -12,11 +12,11 @@ declare class CloudWatchLogs extends Service {
|
|
|
12
12
|
constructor(options?: CloudWatchLogs.Types.ClientConfiguration)
|
|
13
13
|
config: Config & CloudWatchLogs.Types.ClientConfiguration;
|
|
14
14
|
/**
|
|
15
|
-
* Associates the specified
|
|
15
|
+
* Associates the specified KMS key with the specified log group. Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys. It can take up to 5 minutes for this operation to take effect. If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.
|
|
16
16
|
*/
|
|
17
17
|
associateKmsKey(params: CloudWatchLogs.Types.AssociateKmsKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
18
18
|
/**
|
|
19
|
-
* Associates the specified
|
|
19
|
+
* Associates the specified KMS key with the specified log group. Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys. It can take up to 5 minutes for this operation to take effect. If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.
|
|
20
20
|
*/
|
|
21
21
|
associateKmsKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
22
22
|
/**
|
|
@@ -28,29 +28,37 @@ declare class CloudWatchLogs extends Service {
|
|
|
28
28
|
*/
|
|
29
29
|
cancelExportTask(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
30
30
|
/**
|
|
31
|
-
* Creates an export task
|
|
31
|
+
* Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination. Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported. Exporting to S3 buckets that are encrypted with AES-256 is supported. This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask. You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects. Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
|
|
32
32
|
*/
|
|
33
33
|
createExportTask(params: CloudWatchLogs.Types.CreateExportTaskRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.CreateExportTaskResponse) => void): Request<CloudWatchLogs.Types.CreateExportTaskResponse, AWSError>;
|
|
34
34
|
/**
|
|
35
|
-
* Creates an export task
|
|
35
|
+
* Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination. Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported. Exporting to S3 buckets that are encrypted with AES-256 is supported. This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask. You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects. Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
|
|
36
36
|
*/
|
|
37
37
|
createExportTask(callback?: (err: AWSError, data: CloudWatchLogs.Types.CreateExportTaskResponse) => void): Request<CloudWatchLogs.Types.CreateExportTaskResponse, AWSError>;
|
|
38
38
|
/**
|
|
39
|
-
* Creates a log group with the specified name. You can create up to 20,000 log groups per account. You must use the following guidelines when naming a log group: Log group names must be unique within a
|
|
39
|
+
* Creates a log group with the specified name. You can create up to 20,000 log groups per account. You must use the following guidelines when naming a log group: Log group names must be unique within a Region for an Amazon Web Services account. Log group names can be between 1 and 512 characters long. Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign) 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 PutRetentionPolicy. If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. If you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is disabled, you receive an InvalidParameterException error. CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
|
|
40
40
|
*/
|
|
41
41
|
createLogGroup(params: CloudWatchLogs.Types.CreateLogGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
42
42
|
/**
|
|
43
|
-
* Creates a log group with the specified name. You can create up to 20,000 log groups per account. You must use the following guidelines when naming a log group: Log group names must be unique within a
|
|
43
|
+
* Creates a log group with the specified name. You can create up to 20,000 log groups per account. You must use the following guidelines when naming a log group: Log group names must be unique within a Region for an Amazon Web Services account. Log group names can be between 1 and 512 characters long. Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign) 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 PutRetentionPolicy. If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. If you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is disabled, you receive an InvalidParameterException error. CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
|
|
44
44
|
*/
|
|
45
45
|
createLogGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
46
46
|
/**
|
|
47
|
-
* Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored. There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled. You must use the following guidelines when naming a log stream: Log stream names must be unique within the log group. Log stream names can be between 1 and 512 characters long.
|
|
47
|
+
* Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored. There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled. You must use the following guidelines when naming a log stream: Log stream names must be unique within the log group. Log stream names can be between 1 and 512 characters long. Don't use ':' (colon) or '*' (asterisk) characters.
|
|
48
48
|
*/
|
|
49
49
|
createLogStream(params: CloudWatchLogs.Types.CreateLogStreamRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
50
50
|
/**
|
|
51
|
-
* Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored. There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled. You must use the following guidelines when naming a log stream: Log stream names must be unique within the log group. Log stream names can be between 1 and 512 characters long.
|
|
51
|
+
* Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored. There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled. You must use the following guidelines when naming a log stream: Log stream names must be unique within the log group. Log stream names can be between 1 and 512 characters long. Don't use ':' (colon) or '*' (asterisk) characters.
|
|
52
52
|
*/
|
|
53
53
|
createLogStream(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
54
|
+
/**
|
|
55
|
+
* Deletes the data protection policy from the specified log group. For more information about data protection policies, see PutDataProtectionPolicy.
|
|
56
|
+
*/
|
|
57
|
+
deleteDataProtectionPolicy(params: CloudWatchLogs.Types.DeleteDataProtectionPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
58
|
+
/**
|
|
59
|
+
* Deletes the data protection policy from the specified log group. For more information about data protection policies, see PutDataProtectionPolicy.
|
|
60
|
+
*/
|
|
61
|
+
deleteDataProtectionPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
54
62
|
/**
|
|
55
63
|
* Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.
|
|
56
64
|
*/
|
|
@@ -132,19 +140,19 @@ declare class CloudWatchLogs extends Service {
|
|
|
132
140
|
*/
|
|
133
141
|
describeExportTasks(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeExportTasksResponse) => void): Request<CloudWatchLogs.Types.DescribeExportTasksResponse, AWSError>;
|
|
134
142
|
/**
|
|
135
|
-
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name. CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
|
|
143
|
+
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name. CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
136
144
|
*/
|
|
137
145
|
describeLogGroups(params: CloudWatchLogs.Types.DescribeLogGroupsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogGroupsResponse) => void): Request<CloudWatchLogs.Types.DescribeLogGroupsResponse, AWSError>;
|
|
138
146
|
/**
|
|
139
|
-
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name. CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
|
|
147
|
+
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name. CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
140
148
|
*/
|
|
141
149
|
describeLogGroups(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogGroupsResponse) => void): Request<CloudWatchLogs.Types.DescribeLogGroupsResponse, AWSError>;
|
|
142
150
|
/**
|
|
143
|
-
* Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered. This operation has a limit of five transactions per second, after which transactions are throttled.
|
|
151
|
+
* Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered. This operation has a limit of five transactions per second, after which transactions are throttled. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
144
152
|
*/
|
|
145
153
|
describeLogStreams(params: CloudWatchLogs.Types.DescribeLogStreamsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogStreamsResponse) => void): Request<CloudWatchLogs.Types.DescribeLogStreamsResponse, AWSError>;
|
|
146
154
|
/**
|
|
147
|
-
* Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered. This operation has a limit of five transactions per second, after which transactions are throttled.
|
|
155
|
+
* Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered. This operation has a limit of five transactions per second, after which transactions are throttled. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
148
156
|
*/
|
|
149
157
|
describeLogStreams(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogStreamsResponse) => void): Request<CloudWatchLogs.Types.DescribeLogStreamsResponse, AWSError>;
|
|
150
158
|
/**
|
|
@@ -156,11 +164,11 @@ declare class CloudWatchLogs extends Service {
|
|
|
156
164
|
*/
|
|
157
165
|
describeMetricFilters(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeMetricFiltersResponse) => void): Request<CloudWatchLogs.Types.DescribeMetricFiltersResponse, AWSError>;
|
|
158
166
|
/**
|
|
159
|
-
* Returns a list of CloudWatch Logs Insights queries that are scheduled,
|
|
167
|
+
* Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
|
|
160
168
|
*/
|
|
161
169
|
describeQueries(params: CloudWatchLogs.Types.DescribeQueriesRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeQueriesResponse) => void): Request<CloudWatchLogs.Types.DescribeQueriesResponse, AWSError>;
|
|
162
170
|
/**
|
|
163
|
-
* Returns a list of CloudWatch Logs Insights queries that are scheduled,
|
|
171
|
+
* Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
|
|
164
172
|
*/
|
|
165
173
|
describeQueries(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeQueriesResponse) => void): Request<CloudWatchLogs.Types.DescribeQueriesResponse, AWSError>;
|
|
166
174
|
/**
|
|
@@ -188,35 +196,43 @@ declare class CloudWatchLogs extends Service {
|
|
|
188
196
|
*/
|
|
189
197
|
describeSubscriptionFilters(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeSubscriptionFiltersResponse) => void): Request<CloudWatchLogs.Types.DescribeSubscriptionFiltersResponse, AWSError>;
|
|
190
198
|
/**
|
|
191
|
-
* Disassociates the associated
|
|
199
|
+
* Disassociates the associated KMS key from the specified log group. After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the KMS key whenever the encrypted data is requested. Note that it can take up to 5 minutes for this operation to take effect.
|
|
192
200
|
*/
|
|
193
201
|
disassociateKmsKey(params: CloudWatchLogs.Types.DisassociateKmsKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
194
202
|
/**
|
|
195
|
-
* Disassociates the associated
|
|
203
|
+
* Disassociates the associated KMS key from the specified log group. After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the KMS key whenever the encrypted data is requested. Note that it can take up to 5 minutes for this operation to take effect.
|
|
196
204
|
*/
|
|
197
205
|
disassociateKmsKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
198
206
|
/**
|
|
199
|
-
* Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream. You must have the logs;FilterLogEvents permission to perform this operation. By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the time range
|
|
207
|
+
* Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream. You must have the logs;FilterLogEvents permission to perform this operation. By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token. The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
200
208
|
*/
|
|
201
209
|
filterLogEvents(params: CloudWatchLogs.Types.FilterLogEventsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.FilterLogEventsResponse) => void): Request<CloudWatchLogs.Types.FilterLogEventsResponse, AWSError>;
|
|
202
210
|
/**
|
|
203
|
-
* Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream. You must have the logs;FilterLogEvents permission to perform this operation. By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the time range
|
|
211
|
+
* Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream. You must have the logs;FilterLogEvents permission to perform this operation. By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token. The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
204
212
|
*/
|
|
205
213
|
filterLogEvents(callback?: (err: AWSError, data: CloudWatchLogs.Types.FilterLogEventsResponse) => void): Request<CloudWatchLogs.Types.FilterLogEventsResponse, AWSError>;
|
|
206
214
|
/**
|
|
207
|
-
*
|
|
215
|
+
* Returns information about a log group data protection policy.
|
|
216
|
+
*/
|
|
217
|
+
getDataProtectionPolicy(params: CloudWatchLogs.Types.GetDataProtectionPolicyRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetDataProtectionPolicyResponse) => void): Request<CloudWatchLogs.Types.GetDataProtectionPolicyResponse, AWSError>;
|
|
218
|
+
/**
|
|
219
|
+
* Returns information about a log group data protection policy.
|
|
220
|
+
*/
|
|
221
|
+
getDataProtectionPolicy(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetDataProtectionPolicyResponse) => void): Request<CloudWatchLogs.Types.GetDataProtectionPolicyResponse, AWSError>;
|
|
222
|
+
/**
|
|
223
|
+
* Lists log events from the specified log stream. You can list all of the log events or filter using a time range. By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
208
224
|
*/
|
|
209
225
|
getLogEvents(params: CloudWatchLogs.Types.GetLogEventsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogEventsResponse) => void): Request<CloudWatchLogs.Types.GetLogEventsResponse, AWSError>;
|
|
210
226
|
/**
|
|
211
|
-
* Lists log events from the specified log stream. You can list all of the log events or filter using a time range. By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.
|
|
227
|
+
* Lists log events from the specified log stream. You can list all of the log events or filter using a time range. By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
212
228
|
*/
|
|
213
229
|
getLogEvents(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogEventsResponse) => void): Request<CloudWatchLogs.Types.GetLogEventsResponse, AWSError>;
|
|
214
230
|
/**
|
|
215
|
-
* Returns a list of the fields that are included in log events in the specified log group
|
|
231
|
+
* Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify. In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields. The response results are sorted by the frequency percentage, starting with the highest percentage. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
216
232
|
*/
|
|
217
233
|
getLogGroupFields(params: CloudWatchLogs.Types.GetLogGroupFieldsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogGroupFieldsResponse) => void): Request<CloudWatchLogs.Types.GetLogGroupFieldsResponse, AWSError>;
|
|
218
234
|
/**
|
|
219
|
-
* Returns a list of the fields that are included in log events in the specified log group
|
|
235
|
+
* Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify. In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields. The response results are sorted by the frequency percentage, starting with the highest percentage. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
220
236
|
*/
|
|
221
237
|
getLogGroupFields(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogGroupFieldsResponse) => void): Request<CloudWatchLogs.Types.GetLogGroupFieldsResponse, AWSError>;
|
|
222
238
|
/**
|
|
@@ -228,11 +244,11 @@ declare class CloudWatchLogs extends Service {
|
|
|
228
244
|
*/
|
|
229
245
|
getLogRecord(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogRecordResponse) => void): Request<CloudWatchLogs.Types.GetLogRecordResponse, AWSError>;
|
|
230
246
|
/**
|
|
231
|
-
* Returns the results from the specified query. Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record. GetQueryResults does not start a query
|
|
247
|
+
* Returns the results from the specified query. Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record. GetQueryResults does not start running a query. To run a query, use StartQuery. If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
232
248
|
*/
|
|
233
249
|
getQueryResults(params: CloudWatchLogs.Types.GetQueryResultsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetQueryResultsResponse) => void): Request<CloudWatchLogs.Types.GetQueryResultsResponse, AWSError>;
|
|
234
250
|
/**
|
|
235
|
-
* Returns the results from the specified query. Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record. GetQueryResults does not start a query
|
|
251
|
+
* Returns the results from the specified query. Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record. GetQueryResults does not start running a query. To run a query, use StartQuery. If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
|
|
236
252
|
*/
|
|
237
253
|
getQueryResults(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetQueryResultsResponse) => void): Request<CloudWatchLogs.Types.GetQueryResultsResponse, AWSError>;
|
|
238
254
|
/**
|
|
@@ -252,11 +268,19 @@ declare class CloudWatchLogs extends Service {
|
|
|
252
268
|
*/
|
|
253
269
|
listTagsLogGroup(callback?: (err: AWSError, data: CloudWatchLogs.Types.ListTagsLogGroupResponse) => void): Request<CloudWatchLogs.Types.ListTagsLogGroupResponse, AWSError>;
|
|
254
270
|
/**
|
|
255
|
-
* Creates
|
|
271
|
+
* Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked. By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command. For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
|
|
272
|
+
*/
|
|
273
|
+
putDataProtectionPolicy(params: CloudWatchLogs.Types.PutDataProtectionPolicyRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutDataProtectionPolicyResponse) => void): Request<CloudWatchLogs.Types.PutDataProtectionPolicyResponse, AWSError>;
|
|
274
|
+
/**
|
|
275
|
+
* Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked. By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command. For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
|
|
276
|
+
*/
|
|
277
|
+
putDataProtectionPolicy(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutDataProtectionPolicyResponse) => void): Request<CloudWatchLogs.Types.PutDataProtectionPolicyResponse, AWSError>;
|
|
278
|
+
/**
|
|
279
|
+
* Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions. A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination. To perform a PutDestination operation, you must also have the iam:PassRole permission.
|
|
256
280
|
*/
|
|
257
281
|
putDestination(params: CloudWatchLogs.Types.PutDestinationRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutDestinationResponse) => void): Request<CloudWatchLogs.Types.PutDestinationResponse, AWSError>;
|
|
258
282
|
/**
|
|
259
|
-
* Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions. A destination encapsulates a physical resource (such as an Amazon Kinesis stream)
|
|
283
|
+
* Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions. A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination. To perform a PutDestination operation, you must also have the iam:PassRole permission.
|
|
260
284
|
*/
|
|
261
285
|
putDestination(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutDestinationResponse) => void): Request<CloudWatchLogs.Types.PutDestinationResponse, AWSError>;
|
|
262
286
|
/**
|
|
@@ -268,27 +292,27 @@ declare class CloudWatchLogs extends Service {
|
|
|
268
292
|
*/
|
|
269
293
|
putDestinationPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
270
294
|
/**
|
|
271
|
-
* Uploads a batch of log events to the specified log stream. You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected. The batch of events must satisfy the following constraints: The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. None of the log events in the batch can be more than 2 hours in the future. None of the log events in the batch can be
|
|
295
|
+
* Uploads a batch of log events to the specified log stream. You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected. The batch of events must satisfy the following constraints: The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. None of the log events in the batch can be more than 2 hours in the future. None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group. The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.) A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails. The maximum number of log events in a batch is 10,000. There is a quota of five requests per second per log stream. Additional requests are throttled. This quota can't be changed. If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.
|
|
272
296
|
*/
|
|
273
297
|
putLogEvents(params: CloudWatchLogs.Types.PutLogEventsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutLogEventsResponse) => void): Request<CloudWatchLogs.Types.PutLogEventsResponse, AWSError>;
|
|
274
298
|
/**
|
|
275
|
-
* Uploads a batch of log events to the specified log stream. You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected. The batch of events must satisfy the following constraints: The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. None of the log events in the batch can be more than 2 hours in the future. None of the log events in the batch can be
|
|
299
|
+
* Uploads a batch of log events to the specified log stream. You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected. The batch of events must satisfy the following constraints: The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event. None of the log events in the batch can be more than 2 hours in the future. None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group. The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.) A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails. The maximum number of log events in a batch is 10,000. There is a quota of five requests per second per log stream. Additional requests are throttled. This quota can't be changed. If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.
|
|
276
300
|
*/
|
|
277
301
|
putLogEvents(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutLogEventsResponse) => void): Request<CloudWatchLogs.Types.PutLogEventsResponse, AWSError>;
|
|
278
302
|
/**
|
|
279
|
-
* Creates or updates a metric filter and associates it with the specified log group.
|
|
303
|
+
* Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents. The maximum number of metric filters that can be associated with a log group is 100. When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
|
|
280
304
|
*/
|
|
281
305
|
putMetricFilter(params: CloudWatchLogs.Types.PutMetricFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
282
306
|
/**
|
|
283
|
-
* Creates or updates a metric filter and associates it with the specified log group.
|
|
307
|
+
* Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents. The maximum number of metric filters that can be associated with a log group is 100. When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
|
|
284
308
|
*/
|
|
285
309
|
putMetricFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
286
310
|
/**
|
|
287
|
-
* Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights. To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example,
|
|
311
|
+
* Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights. To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups. You must have the logs:PutQueryDefinition permission to be able to perform this operation.
|
|
288
312
|
*/
|
|
289
313
|
putQueryDefinition(params: CloudWatchLogs.Types.PutQueryDefinitionRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutQueryDefinitionResponse) => void): Request<CloudWatchLogs.Types.PutQueryDefinitionResponse, AWSError>;
|
|
290
314
|
/**
|
|
291
|
-
* Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights. To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example,
|
|
315
|
+
* Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights. To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups. You must have the logs:PutQueryDefinition permission to be able to perform this operation.
|
|
292
316
|
*/
|
|
293
317
|
putQueryDefinition(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutQueryDefinitionResponse) => void): Request<CloudWatchLogs.Types.PutQueryDefinitionResponse, AWSError>;
|
|
294
318
|
/**
|
|
@@ -300,27 +324,27 @@ declare class CloudWatchLogs extends Service {
|
|
|
300
324
|
*/
|
|
301
325
|
putResourcePolicy(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutResourcePolicyResponse) => void): Request<CloudWatchLogs.Types.PutResourcePolicyResponse, AWSError>;
|
|
302
326
|
/**
|
|
303
|
-
* Sets the retention of the specified log group.
|
|
327
|
+
* Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group. CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer. To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
|
|
304
328
|
*/
|
|
305
329
|
putRetentionPolicy(params: CloudWatchLogs.Types.PutRetentionPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
306
330
|
/**
|
|
307
|
-
* Sets the retention of the specified log group.
|
|
331
|
+
* Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group. CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer. To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
|
|
308
332
|
*/
|
|
309
333
|
putRetentionPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
310
334
|
/**
|
|
311
|
-
* Creates or updates a subscription filter and associates it with the specified log group.
|
|
335
|
+
* Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format. The following destinations are supported for subscription filters: An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery. A logical destination that belongs to a different account, for cross-account delivery. An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery. An Lambda function that belongs to the same account as the subscription filter, for same-account delivery. Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName. To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole permission.
|
|
312
336
|
*/
|
|
313
337
|
putSubscriptionFilter(params: CloudWatchLogs.Types.PutSubscriptionFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
314
338
|
/**
|
|
315
|
-
* Creates or updates a subscription filter and associates it with the specified log group.
|
|
339
|
+
* Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format. The following destinations are supported for subscription filters: An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery. A logical destination that belongs to a different account, for cross-account delivery. An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery. An Lambda function that belongs to the same account as the subscription filter, for same-account delivery. Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName. To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole permission.
|
|
316
340
|
*/
|
|
317
341
|
putSubscriptionFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
318
342
|
/**
|
|
319
|
-
* Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use. For more information, see CloudWatch Logs Insights Query Syntax. Queries time out after 15 minutes of
|
|
343
|
+
* Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use. For more information, see CloudWatch Logs Insights Query Syntax. Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account. You can have up to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
|
|
320
344
|
*/
|
|
321
345
|
startQuery(params: CloudWatchLogs.Types.StartQueryRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.StartQueryResponse) => void): Request<CloudWatchLogs.Types.StartQueryResponse, AWSError>;
|
|
322
346
|
/**
|
|
323
|
-
* Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use. For more information, see CloudWatch Logs Insights Query Syntax. Queries time out after 15 minutes of
|
|
347
|
+
* Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use. For more information, see CloudWatch Logs Insights Query Syntax. Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries. If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account. You can have up to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
|
|
324
348
|
*/
|
|
325
349
|
startQuery(callback?: (err: AWSError, data: CloudWatchLogs.Types.StartQueryResponse) => void): Request<CloudWatchLogs.Types.StartQueryResponse, AWSError>;
|
|
326
350
|
/**
|
|
@@ -374,6 +398,8 @@ declare class CloudWatchLogs extends Service {
|
|
|
374
398
|
}
|
|
375
399
|
declare namespace CloudWatchLogs {
|
|
376
400
|
export type AccessPolicy = string;
|
|
401
|
+
export type AccountId = string;
|
|
402
|
+
export type AccountIds = AccountId[];
|
|
377
403
|
export type AmazonResourceName = string;
|
|
378
404
|
export type Arn = string;
|
|
379
405
|
export interface AssociateKmsKeyRequest {
|
|
@@ -382,7 +408,7 @@ declare namespace CloudWatchLogs {
|
|
|
382
408
|
*/
|
|
383
409
|
logGroupName: LogGroupName;
|
|
384
410
|
/**
|
|
385
|
-
* The Amazon Resource Name (ARN) of the
|
|
411
|
+
* The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.
|
|
386
412
|
*/
|
|
387
413
|
kmsKeyId: KmsKeyId;
|
|
388
414
|
}
|
|
@@ -414,7 +440,7 @@ declare namespace CloudWatchLogs {
|
|
|
414
440
|
*/
|
|
415
441
|
to: Timestamp;
|
|
416
442
|
/**
|
|
417
|
-
* The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services
|
|
443
|
+
* The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.
|
|
418
444
|
*/
|
|
419
445
|
destination: ExportDestinationBucket;
|
|
420
446
|
/**
|
|
@@ -434,7 +460,7 @@ declare namespace CloudWatchLogs {
|
|
|
434
460
|
*/
|
|
435
461
|
logGroupName: LogGroupName;
|
|
436
462
|
/**
|
|
437
|
-
* The Amazon Resource Name (ARN) of the
|
|
463
|
+
* The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.
|
|
438
464
|
*/
|
|
439
465
|
kmsKeyId?: KmsKeyId;
|
|
440
466
|
/**
|
|
@@ -452,8 +478,16 @@ declare namespace CloudWatchLogs {
|
|
|
452
478
|
*/
|
|
453
479
|
logStreamName: LogStreamName;
|
|
454
480
|
}
|
|
481
|
+
export type DataProtectionPolicyDocument = string;
|
|
482
|
+
export type DataProtectionStatus = "ACTIVATED"|"DELETED"|"ARCHIVED"|"DISABLED"|string;
|
|
455
483
|
export type Days = number;
|
|
456
484
|
export type DefaultValue = number;
|
|
485
|
+
export interface DeleteDataProtectionPolicyRequest {
|
|
486
|
+
/**
|
|
487
|
+
* The name or ARN of the log group that you want to delete the data protection policy for.
|
|
488
|
+
*/
|
|
489
|
+
logGroupIdentifier: LogGroupIdentifier;
|
|
490
|
+
}
|
|
457
491
|
export interface DeleteDestinationRequest {
|
|
458
492
|
/**
|
|
459
493
|
* The name of the destination.
|
|
@@ -544,7 +578,7 @@ declare namespace CloudWatchLogs {
|
|
|
544
578
|
}
|
|
545
579
|
export interface DescribeExportTasksRequest {
|
|
546
580
|
/**
|
|
547
|
-
* The ID of the export task. Specifying a task ID filters the results to
|
|
581
|
+
* The ID of the export task. Specifying a task ID filters the results to one or zero export tasks.
|
|
548
582
|
*/
|
|
549
583
|
taskId?: ExportTaskId;
|
|
550
584
|
/**
|
|
@@ -570,9 +604,17 @@ declare namespace CloudWatchLogs {
|
|
|
570
604
|
export type DescribeLimit = number;
|
|
571
605
|
export interface DescribeLogGroupsRequest {
|
|
572
606
|
/**
|
|
573
|
-
*
|
|
607
|
+
* When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
|
|
608
|
+
*/
|
|
609
|
+
accountIdentifiers?: AccountIds;
|
|
610
|
+
/**
|
|
611
|
+
* The prefix to match. logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.
|
|
574
612
|
*/
|
|
575
613
|
logGroupNamePrefix?: LogGroupName;
|
|
614
|
+
/**
|
|
615
|
+
* If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match. logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.
|
|
616
|
+
*/
|
|
617
|
+
logGroupNamePattern?: LogGroupNamePattern;
|
|
576
618
|
/**
|
|
577
619
|
* The token for the next set of items to return. (You received this token from a previous call.)
|
|
578
620
|
*/
|
|
@@ -581,19 +623,27 @@ declare namespace CloudWatchLogs {
|
|
|
581
623
|
* The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
|
|
582
624
|
*/
|
|
583
625
|
limit?: DescribeLimit;
|
|
626
|
+
/**
|
|
627
|
+
* If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers. If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account. If you specify includeLinkedAccounts in your request, then metricFilterCount, retentionInDays, and storedBytes are not included in the response.
|
|
628
|
+
*/
|
|
629
|
+
includeLinkedAccounts?: IncludeLinkedAccounts;
|
|
584
630
|
}
|
|
585
631
|
export interface DescribeLogGroupsResponse {
|
|
586
632
|
/**
|
|
587
|
-
* The log groups. If the retentionInDays value is not included for a log group, then that log group
|
|
633
|
+
* The log groups. If the retentionInDays value is not included for a log group, then that log group's events do not expire.
|
|
588
634
|
*/
|
|
589
635
|
logGroups?: LogGroups;
|
|
590
636
|
nextToken?: NextToken;
|
|
591
637
|
}
|
|
592
638
|
export interface DescribeLogStreamsRequest {
|
|
593
639
|
/**
|
|
594
|
-
* The name of the log group.
|
|
640
|
+
* The name of the log group. If you specify values for both logGroupName and logGroupIdentifier, the action returns an InvalidParameterException error.
|
|
595
641
|
*/
|
|
596
642
|
logGroupName: LogGroupName;
|
|
643
|
+
/**
|
|
644
|
+
* Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. If you specify values for both logGroupName and logGroupIdentifier, the action returns an InvalidParameterException error.
|
|
645
|
+
*/
|
|
646
|
+
logGroupIdentifier?: LogGroupIdentifier;
|
|
597
647
|
/**
|
|
598
648
|
* The prefix to match. If orderBy is LastEventTime, you cannot specify this parameter.
|
|
599
649
|
*/
|
|
@@ -628,7 +678,7 @@ declare namespace CloudWatchLogs {
|
|
|
628
678
|
*/
|
|
629
679
|
logGroupName?: LogGroupName;
|
|
630
680
|
/**
|
|
631
|
-
* The prefix to match. CloudWatch Logs uses the value you set here only if you also include the logGroupName parameter in your request.
|
|
681
|
+
* The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the logGroupName parameter in your request.
|
|
632
682
|
*/
|
|
633
683
|
filterNamePrefix?: FilterName;
|
|
634
684
|
/**
|
|
@@ -848,9 +898,13 @@ declare namespace CloudWatchLogs {
|
|
|
848
898
|
export type FilterCount = number;
|
|
849
899
|
export interface FilterLogEventsRequest {
|
|
850
900
|
/**
|
|
851
|
-
* The name of the log group to search.
|
|
901
|
+
* The name of the log group to search. If you specify values for both logGroupName and logGroupIdentifier, the action returns an InvalidParameterException error.
|
|
852
902
|
*/
|
|
853
903
|
logGroupName: LogGroupName;
|
|
904
|
+
/**
|
|
905
|
+
* Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. If you specify values for both logGroupName and logGroupIdentifier, the action returns an InvalidParameterException error.
|
|
906
|
+
*/
|
|
907
|
+
logGroupIdentifier?: LogGroupIdentifier;
|
|
854
908
|
/**
|
|
855
909
|
* Filters the results to only logs from the log streams in this list. If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.
|
|
856
910
|
*/
|
|
@@ -880,9 +934,13 @@ declare namespace CloudWatchLogs {
|
|
|
880
934
|
*/
|
|
881
935
|
limit?: EventsLimit;
|
|
882
936
|
/**
|
|
883
|
-
* If the value is true, the operation
|
|
937
|
+
* If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
|
|
884
938
|
*/
|
|
885
939
|
interleaved?: Interleaved;
|
|
940
|
+
/**
|
|
941
|
+
* Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false. To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
|
|
942
|
+
*/
|
|
943
|
+
unmask?: Unmask;
|
|
886
944
|
}
|
|
887
945
|
export interface FilterLogEventsResponse {
|
|
888
946
|
/**
|
|
@@ -890,7 +948,7 @@ declare namespace CloudWatchLogs {
|
|
|
890
948
|
*/
|
|
891
949
|
events?: FilteredLogEvents;
|
|
892
950
|
/**
|
|
893
|
-
*
|
|
951
|
+
* Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list. Indicates which log streams have been searched and whether each has been searched completely.
|
|
894
952
|
*/
|
|
895
953
|
searchedLogStreams?: SearchedLogStreams;
|
|
896
954
|
/**
|
|
@@ -924,11 +982,35 @@ declare namespace CloudWatchLogs {
|
|
|
924
982
|
}
|
|
925
983
|
export type FilteredLogEvents = FilteredLogEvent[];
|
|
926
984
|
export type ForceUpdate = boolean;
|
|
985
|
+
export interface GetDataProtectionPolicyRequest {
|
|
986
|
+
/**
|
|
987
|
+
* The name or ARN of the log group that contains the data protection policy that you want to see.
|
|
988
|
+
*/
|
|
989
|
+
logGroupIdentifier: LogGroupIdentifier;
|
|
990
|
+
}
|
|
991
|
+
export interface GetDataProtectionPolicyResponse {
|
|
992
|
+
/**
|
|
993
|
+
* The log group name or ARN that you specified in your request.
|
|
994
|
+
*/
|
|
995
|
+
logGroupIdentifier?: LogGroupIdentifier;
|
|
996
|
+
/**
|
|
997
|
+
* The data protection policy document for this log group.
|
|
998
|
+
*/
|
|
999
|
+
policyDocument?: DataProtectionPolicyDocument;
|
|
1000
|
+
/**
|
|
1001
|
+
* The date and time that this policy was most recently updated.
|
|
1002
|
+
*/
|
|
1003
|
+
lastUpdatedTime?: Timestamp;
|
|
1004
|
+
}
|
|
927
1005
|
export interface GetLogEventsRequest {
|
|
928
1006
|
/**
|
|
929
|
-
* The name of the log group.
|
|
1007
|
+
* The name of the log group. If you specify values for both logGroupName and logGroupIdentifier, the action returns an InvalidParameterException error.
|
|
930
1008
|
*/
|
|
931
1009
|
logGroupName: LogGroupName;
|
|
1010
|
+
/**
|
|
1011
|
+
* Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. If you specify values for both logGroupName and logGroupIdentifier, the action returns an InvalidParameterException error.
|
|
1012
|
+
*/
|
|
1013
|
+
logGroupIdentifier?: LogGroupIdentifier;
|
|
932
1014
|
/**
|
|
933
1015
|
* The name of the log stream.
|
|
934
1016
|
*/
|
|
@@ -946,13 +1028,17 @@ declare namespace CloudWatchLogs {
|
|
|
946
1028
|
*/
|
|
947
1029
|
nextToken?: NextToken;
|
|
948
1030
|
/**
|
|
949
|
-
* The maximum number of log events returned. If you don't specify a
|
|
1031
|
+
* The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).
|
|
950
1032
|
*/
|
|
951
1033
|
limit?: EventsLimit;
|
|
952
1034
|
/**
|
|
953
1035
|
* If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false. If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.
|
|
954
1036
|
*/
|
|
955
1037
|
startFromHead?: StartFromHead;
|
|
1038
|
+
/**
|
|
1039
|
+
* Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false. To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
|
|
1040
|
+
*/
|
|
1041
|
+
unmask?: Unmask;
|
|
956
1042
|
}
|
|
957
1043
|
export interface GetLogEventsResponse {
|
|
958
1044
|
/**
|
|
@@ -964,19 +1050,23 @@ declare namespace CloudWatchLogs {
|
|
|
964
1050
|
*/
|
|
965
1051
|
nextForwardToken?: NextToken;
|
|
966
1052
|
/**
|
|
967
|
-
* The token for the next set of items in the backward direction. The token expires after 24 hours. This token is
|
|
1053
|
+
* The token for the next set of items in the backward direction. The token expires after 24 hours. This token is not null. If you have reached the end of the stream, it returns the same token you passed in.
|
|
968
1054
|
*/
|
|
969
1055
|
nextBackwardToken?: NextToken;
|
|
970
1056
|
}
|
|
971
1057
|
export interface GetLogGroupFieldsRequest {
|
|
972
1058
|
/**
|
|
973
|
-
* The name of the log group to search.
|
|
1059
|
+
* The name of the log group to search. If you specify values for both logGroupName and logGroupIdentifier, the action returns an InvalidParameterException error.
|
|
974
1060
|
*/
|
|
975
1061
|
logGroupName: LogGroupName;
|
|
976
1062
|
/**
|
|
977
|
-
* The time to set as the center of the query. If you specify time, the 15 minutes before this time are queries. If you omit time the 8 minutes before and 8 minutes after this time are searched. The time value is specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.
|
|
1063
|
+
* The time to set as the center of the query. If you specify time, the 15 minutes before this time are queries. If you omit time, the 8 minutes before and 8 minutes after this time are searched. The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.
|
|
978
1064
|
*/
|
|
979
1065
|
time?: Timestamp;
|
|
1066
|
+
/**
|
|
1067
|
+
* Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN. If you specify values for both logGroupName and logGroupIdentifier, the action returns an InvalidParameterException error.
|
|
1068
|
+
*/
|
|
1069
|
+
logGroupIdentifier?: LogGroupIdentifier;
|
|
980
1070
|
}
|
|
981
1071
|
export interface GetLogGroupFieldsResponse {
|
|
982
1072
|
/**
|
|
@@ -989,6 +1079,10 @@ declare namespace CloudWatchLogs {
|
|
|
989
1079
|
* The pointer corresponding to the log event record you want to retrieve. You get this from the response of a GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record.
|
|
990
1080
|
*/
|
|
991
1081
|
logRecordPointer: LogRecordPointer;
|
|
1082
|
+
/**
|
|
1083
|
+
* Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false. To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
|
|
1084
|
+
*/
|
|
1085
|
+
unmask?: Unmask;
|
|
992
1086
|
}
|
|
993
1087
|
export interface GetLogRecordResponse {
|
|
994
1088
|
/**
|
|
@@ -1012,10 +1106,11 @@ declare namespace CloudWatchLogs {
|
|
|
1012
1106
|
*/
|
|
1013
1107
|
statistics?: QueryStatistics;
|
|
1014
1108
|
/**
|
|
1015
|
-
* The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown. Queries time out after 15 minutes of
|
|
1109
|
+
* The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown. Queries time out after 15 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.
|
|
1016
1110
|
*/
|
|
1017
1111
|
status?: QueryStatus;
|
|
1018
1112
|
}
|
|
1113
|
+
export type IncludeLinkedAccounts = boolean;
|
|
1019
1114
|
export interface InputLogEvent {
|
|
1020
1115
|
/**
|
|
1021
1116
|
* The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
|
|
@@ -1078,9 +1173,13 @@ declare namespace CloudWatchLogs {
|
|
|
1078
1173
|
*/
|
|
1079
1174
|
storedBytes?: StoredBytes;
|
|
1080
1175
|
/**
|
|
1081
|
-
* The Amazon Resource Name (ARN) of the
|
|
1176
|
+
* The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
|
|
1082
1177
|
*/
|
|
1083
1178
|
kmsKeyId?: KmsKeyId;
|
|
1179
|
+
/**
|
|
1180
|
+
* Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
|
|
1181
|
+
*/
|
|
1182
|
+
dataProtectionStatus?: DataProtectionStatus;
|
|
1084
1183
|
}
|
|
1085
1184
|
export interface LogGroupField {
|
|
1086
1185
|
/**
|
|
@@ -1093,7 +1192,10 @@ declare namespace CloudWatchLogs {
|
|
|
1093
1192
|
percent?: Percentage;
|
|
1094
1193
|
}
|
|
1095
1194
|
export type LogGroupFieldList = LogGroupField[];
|
|
1195
|
+
export type LogGroupIdentifier = string;
|
|
1196
|
+
export type LogGroupIdentifiers = LogGroupIdentifier[];
|
|
1096
1197
|
export type LogGroupName = string;
|
|
1198
|
+
export type LogGroupNamePattern = string;
|
|
1097
1199
|
export type LogGroupNames = LogGroupName[];
|
|
1098
1200
|
export type LogGroups = LogGroup[];
|
|
1099
1201
|
export type LogRecord = {[key: string]: Value};
|
|
@@ -1128,7 +1230,7 @@ declare namespace CloudWatchLogs {
|
|
|
1128
1230
|
*/
|
|
1129
1231
|
arn?: Arn;
|
|
1130
1232
|
/**
|
|
1131
|
-
* The number of bytes stored. Important:
|
|
1233
|
+
* The number of bytes stored. Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.
|
|
1132
1234
|
*/
|
|
1133
1235
|
storedBytes?: StoredBytes;
|
|
1134
1236
|
}
|
|
@@ -1190,7 +1292,7 @@ declare namespace CloudWatchLogs {
|
|
|
1190
1292
|
*/
|
|
1191
1293
|
defaultValue?: DefaultValue;
|
|
1192
1294
|
/**
|
|
1193
|
-
* The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
|
|
1295
|
+
* The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
|
|
1194
1296
|
*/
|
|
1195
1297
|
dimensions?: Dimensions;
|
|
1196
1298
|
/**
|
|
@@ -1220,6 +1322,30 @@ declare namespace CloudWatchLogs {
|
|
|
1220
1322
|
export type Percentage = number;
|
|
1221
1323
|
export type PolicyDocument = string;
|
|
1222
1324
|
export type PolicyName = string;
|
|
1325
|
+
export interface PutDataProtectionPolicyRequest {
|
|
1326
|
+
/**
|
|
1327
|
+
* Specify either the log group name or log group ARN.
|
|
1328
|
+
*/
|
|
1329
|
+
logGroupIdentifier: LogGroupIdentifier;
|
|
1330
|
+
/**
|
|
1331
|
+
* Specify the data protection policy, in JSON. This policy must include two JSON blocks: The first block must include both a DataIdentifer array and an Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask. The Operation property with an Audit action is required to find the sensitive data terms. This Audit action must contain a FindingsDestination object. You can optionally use that FindingsDestination object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist. The second block must include both a DataIdentifer array and an Operation property with an Deidentify action. The DataIdentifer array must exactly match the DataIdentifer array in the first block of the policy. The Operation property with the Deidentify action is what actually masks the data, and it must contain the "MaskConfig": {} object. The "MaskConfig": {} object must be empty. For an example data protection policy, see the Examples section on this page. The contents of two DataIdentifer arrays must match exactly.
|
|
1332
|
+
*/
|
|
1333
|
+
policyDocument: DataProtectionPolicyDocument;
|
|
1334
|
+
}
|
|
1335
|
+
export interface PutDataProtectionPolicyResponse {
|
|
1336
|
+
/**
|
|
1337
|
+
* The log group name or ARN that you specified in your request.
|
|
1338
|
+
*/
|
|
1339
|
+
logGroupIdentifier?: LogGroupIdentifier;
|
|
1340
|
+
/**
|
|
1341
|
+
* The data protection policy used for this log group.
|
|
1342
|
+
*/
|
|
1343
|
+
policyDocument?: DataProtectionPolicyDocument;
|
|
1344
|
+
/**
|
|
1345
|
+
* The date and time that this policy was most recently updated.
|
|
1346
|
+
*/
|
|
1347
|
+
lastUpdatedTime?: Timestamp;
|
|
1348
|
+
}
|
|
1223
1349
|
export interface PutDestinationPolicyRequest {
|
|
1224
1350
|
/**
|
|
1225
1351
|
* A name for an existing destination.
|
|
@@ -1306,7 +1432,7 @@ declare namespace CloudWatchLogs {
|
|
|
1306
1432
|
}
|
|
1307
1433
|
export interface PutQueryDefinitionRequest {
|
|
1308
1434
|
/**
|
|
1309
|
-
* A name for the query definition. If you are saving
|
|
1435
|
+
* A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.
|
|
1310
1436
|
*/
|
|
1311
1437
|
name: QueryDefinitionName;
|
|
1312
1438
|
/**
|
|
@@ -1334,7 +1460,7 @@ declare namespace CloudWatchLogs {
|
|
|
1334
1460
|
*/
|
|
1335
1461
|
policyName?: PolicyName;
|
|
1336
1462
|
/**
|
|
1337
|
-
* Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required. The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream. CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys. In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs
|
|
1463
|
+
* Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required. The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream. CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys. In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs. You would also replace the value of SourceAccount with the Amazon Web Services account ID making that call. { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": "myAwsAccountId" } } } ] }
|
|
1338
1464
|
*/
|
|
1339
1465
|
policyDocument?: PolicyDocument;
|
|
1340
1466
|
}
|
|
@@ -1365,7 +1491,7 @@ declare namespace CloudWatchLogs {
|
|
|
1365
1491
|
*/
|
|
1366
1492
|
filterPattern: FilterPattern;
|
|
1367
1493
|
/**
|
|
1368
|
-
* The ARN of the destination to deliver matching log events to. Currently, the supported destinations are: An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery. If you
|
|
1494
|
+
* The ARN of the destination to deliver matching log events to. Currently, the supported destinations are: An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery. If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy. A Kinesis Data Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery. A Lambda function belonging to the same account as the subscription filter, for same-account delivery.
|
|
1369
1495
|
*/
|
|
1370
1496
|
destinationArn: DestinationArn;
|
|
1371
1497
|
/**
|
|
@@ -1373,7 +1499,7 @@ declare namespace CloudWatchLogs {
|
|
|
1373
1499
|
*/
|
|
1374
1500
|
roleArn?: RoleArn;
|
|
1375
1501
|
/**
|
|
1376
|
-
* The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream.
|
|
1502
|
+
* The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream.
|
|
1377
1503
|
*/
|
|
1378
1504
|
distribution?: Distribution;
|
|
1379
1505
|
}
|
|
@@ -1450,7 +1576,7 @@ declare namespace CloudWatchLogs {
|
|
|
1450
1576
|
*/
|
|
1451
1577
|
tooNewLogEventStartIndex?: LogEventIndex;
|
|
1452
1578
|
/**
|
|
1453
|
-
* The log events that are too
|
|
1579
|
+
* The log events that are dated too far in the past.
|
|
1454
1580
|
*/
|
|
1455
1581
|
tooOldLogEventEndIndex?: LogEventIndex;
|
|
1456
1582
|
/**
|
|
@@ -1501,13 +1627,17 @@ declare namespace CloudWatchLogs {
|
|
|
1501
1627
|
export type StartFromHead = boolean;
|
|
1502
1628
|
export interface StartQueryRequest {
|
|
1503
1629
|
/**
|
|
1504
|
-
* The log group on which to perform the query.
|
|
1630
|
+
* The log group on which to perform the query. A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.
|
|
1505
1631
|
*/
|
|
1506
1632
|
logGroupName?: LogGroupName;
|
|
1507
1633
|
/**
|
|
1508
|
-
* The list of log groups to be queried. You can include up to
|
|
1634
|
+
* The list of log groups to be queried. You can include up to 50 log groups. A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.
|
|
1509
1635
|
*/
|
|
1510
1636
|
logGroupNames?: LogGroupNames;
|
|
1637
|
+
/**
|
|
1638
|
+
* The list of log groups to query. You can include up to 50 log groups. You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account. If you specify an ARN, the ARN can't end with an asterisk (*). A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.
|
|
1639
|
+
*/
|
|
1640
|
+
logGroupIdentifiers?: LogGroupIdentifiers;
|
|
1511
1641
|
/**
|
|
1512
1642
|
* The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.
|
|
1513
1643
|
*/
|
|
@@ -1613,6 +1743,7 @@ declare namespace CloudWatchLogs {
|
|
|
1613
1743
|
}
|
|
1614
1744
|
export type Timestamp = number;
|
|
1615
1745
|
export type Token = string;
|
|
1746
|
+
export type Unmask = boolean;
|
|
1616
1747
|
export interface UntagLogGroupRequest {
|
|
1617
1748
|
/**
|
|
1618
1749
|
* The name of the log group.
|