/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / cloudwatchlogs.d.ts
cloudwatchlogs.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class CloudWatchLogs extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: CloudWatchLogs.Types.ClientConfiguration) 13 config: Config & CloudWatchLogs.Types.ClientConfiguration; 14 /** 15 * Associates the specified Key Management Service customer master key (CMK) with the specified log group. Associating an KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK 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 CMK with a log group but the CMK does not exist or the CMK is disabled, you receive an InvalidParameterException error. 16 */ 17 associateKmsKey(params: CloudWatchLogs.Types.AssociateKmsKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 18 /** 19 * Associates the specified Key Management Service customer master key (CMK) with the specified log group. Associating an KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK 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 CMK with a log group but the CMK does not exist or the CMK is disabled, you receive an InvalidParameterException error. 20 */ 21 associateKmsKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 22 /** 23 * Cancels the specified export task. The task must be in the PENDING or RUNNING state. 24 */ 25 cancelExportTask(params: CloudWatchLogs.Types.CancelExportTaskRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 26 /** 27 * Cancels the specified export task. The task must be in the PENDING or RUNNING state. 28 */ 29 cancelExportTask(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 30 /** 31 * Creates an export task, which allows you to 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. 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 out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects. Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets encrypted with SSE-KMS is not supported. 32 */ 33 createExportTask(params: CloudWatchLogs.Types.CreateExportTaskRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.CreateExportTaskResponse) => void): Request<CloudWatchLogs.Types.CreateExportTaskResponse, AWSError>; 34 /** 35 * Creates an export task, which allows you to 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. 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 out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects. Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets encrypted with SSE-KMS is not supported. 36 */ 37 createExportTask(callback?: (err: AWSError, data: CloudWatchLogs.Types.CreateExportTaskResponse) => void): Request<CloudWatchLogs.Types.CreateExportTaskResponse, AWSError>; 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 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 never expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy. If you associate a Key Management Service customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you receive an InvalidParameterException error. CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys. 40 */ 41 createLogGroup(params: CloudWatchLogs.Types.CreateLogGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 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 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 never expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy. If you associate a Key Management Service customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested. If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you receive an InvalidParameterException error. CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys. 44 */ 45 createLogGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 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. The ':' (colon) and '*' (asterisk) characters are not allowed. 48 */ 49 createLogStream(params: CloudWatchLogs.Types.CreateLogStreamRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 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. The ':' (colon) and '*' (asterisk) characters are not allowed. 52 */ 53 createLogStream(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 54 /** 55 * 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 */ 57 deleteDestination(params: CloudWatchLogs.Types.DeleteDestinationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 58 /** 59 * 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. 60 */ 61 deleteDestination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 62 /** 63 * Deletes the specified log group and permanently deletes all the archived log events associated with the log group. 64 */ 65 deleteLogGroup(params: CloudWatchLogs.Types.DeleteLogGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 66 /** 67 * Deletes the specified log group and permanently deletes all the archived log events associated with the log group. 68 */ 69 deleteLogGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 70 /** 71 * Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. 72 */ 73 deleteLogStream(params: CloudWatchLogs.Types.DeleteLogStreamRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 74 /** 75 * Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. 76 */ 77 deleteLogStream(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 78 /** 79 * Deletes the specified metric filter. 80 */ 81 deleteMetricFilter(params: CloudWatchLogs.Types.DeleteMetricFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 82 /** 83 * Deletes the specified metric filter. 84 */ 85 deleteMetricFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 86 /** 87 * Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query. Each DeleteQueryDefinition operation can delete one query definition. You must have the logs:DeleteQueryDefinition permission to be able to perform this operation. 88 */ 89 deleteQueryDefinition(params: CloudWatchLogs.Types.DeleteQueryDefinitionRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DeleteQueryDefinitionResponse) => void): Request<CloudWatchLogs.Types.DeleteQueryDefinitionResponse, AWSError>; 90 /** 91 * Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query. Each DeleteQueryDefinition operation can delete one query definition. You must have the logs:DeleteQueryDefinition permission to be able to perform this operation. 92 */ 93 deleteQueryDefinition(callback?: (err: AWSError, data: CloudWatchLogs.Types.DeleteQueryDefinitionResponse) => void): Request<CloudWatchLogs.Types.DeleteQueryDefinitionResponse, AWSError>; 94 /** 95 * Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account. 96 */ 97 deleteResourcePolicy(params: CloudWatchLogs.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 98 /** 99 * Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account. 100 */ 101 deleteResourcePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 102 /** 103 * Deletes the specified retention policy. Log events do not expire if they belong to log groups without a retention policy. 104 */ 105 deleteRetentionPolicy(params: CloudWatchLogs.Types.DeleteRetentionPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 106 /** 107 * Deletes the specified retention policy. Log events do not expire if they belong to log groups without a retention policy. 108 */ 109 deleteRetentionPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 110 /** 111 * Deletes the specified subscription filter. 112 */ 113 deleteSubscriptionFilter(params: CloudWatchLogs.Types.DeleteSubscriptionFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 114 /** 115 * Deletes the specified subscription filter. 116 */ 117 deleteSubscriptionFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 118 /** 119 * Lists all your destinations. The results are ASCII-sorted by destination name. 120 */ 121 describeDestinations(params: CloudWatchLogs.Types.DescribeDestinationsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeDestinationsResponse) => void): Request<CloudWatchLogs.Types.DescribeDestinationsResponse, AWSError>; 122 /** 123 * Lists all your destinations. The results are ASCII-sorted by destination name. 124 */ 125 describeDestinations(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeDestinationsResponse) => void): Request<CloudWatchLogs.Types.DescribeDestinationsResponse, AWSError>; 126 /** 127 * Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status. 128 */ 129 describeExportTasks(params: CloudWatchLogs.Types.DescribeExportTasksRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeExportTasksResponse) => void): Request<CloudWatchLogs.Types.DescribeExportTasksResponse, AWSError>; 130 /** 131 * Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status. 132 */ 133 describeExportTasks(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeExportTasksResponse) => void): Request<CloudWatchLogs.Types.DescribeExportTasksResponse, AWSError>; 134 /** 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. 136 */ 137 describeLogGroups(params: CloudWatchLogs.Types.DescribeLogGroupsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogGroupsResponse) => void): Request<CloudWatchLogs.Types.DescribeLogGroupsResponse, AWSError>; 138 /** 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. 140 */ 141 describeLogGroups(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogGroupsResponse) => void): Request<CloudWatchLogs.Types.DescribeLogGroupsResponse, AWSError>; 142 /** 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. 144 */ 145 describeLogStreams(params: CloudWatchLogs.Types.DescribeLogStreamsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogStreamsResponse) => void): Request<CloudWatchLogs.Types.DescribeLogStreamsResponse, AWSError>; 146 /** 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. 148 */ 149 describeLogStreams(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeLogStreamsResponse) => void): Request<CloudWatchLogs.Types.DescribeLogStreamsResponse, AWSError>; 150 /** 151 * Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name. 152 */ 153 describeMetricFilters(params: CloudWatchLogs.Types.DescribeMetricFiltersRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeMetricFiltersResponse) => void): Request<CloudWatchLogs.Types.DescribeMetricFiltersResponse, AWSError>; 154 /** 155 * Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name. 156 */ 157 describeMetricFilters(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeMetricFiltersResponse) => void): Request<CloudWatchLogs.Types.DescribeMetricFiltersResponse, AWSError>; 158 /** 159 * Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed 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 */ 161 describeQueries(params: CloudWatchLogs.Types.DescribeQueriesRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeQueriesResponse) => void): Request<CloudWatchLogs.Types.DescribeQueriesResponse, AWSError>; 162 /** 163 * Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed 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 */ 165 describeQueries(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeQueriesResponse) => void): Request<CloudWatchLogs.Types.DescribeQueriesResponse, AWSError>; 166 /** 167 * This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string. 168 */ 169 describeQueryDefinitions(params: CloudWatchLogs.Types.DescribeQueryDefinitionsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeQueryDefinitionsResponse) => void): Request<CloudWatchLogs.Types.DescribeQueryDefinitionsResponse, AWSError>; 170 /** 171 * This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string. 172 */ 173 describeQueryDefinitions(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeQueryDefinitionsResponse) => void): Request<CloudWatchLogs.Types.DescribeQueryDefinitionsResponse, AWSError>; 174 /** 175 * Lists the resource policies in this account. 176 */ 177 describeResourcePolicies(params: CloudWatchLogs.Types.DescribeResourcePoliciesRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeResourcePoliciesResponse) => void): Request<CloudWatchLogs.Types.DescribeResourcePoliciesResponse, AWSError>; 178 /** 179 * Lists the resource policies in this account. 180 */ 181 describeResourcePolicies(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeResourcePoliciesResponse) => void): Request<CloudWatchLogs.Types.DescribeResourcePoliciesResponse, AWSError>; 182 /** 183 * Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name. 184 */ 185 describeSubscriptionFilters(params: CloudWatchLogs.Types.DescribeSubscriptionFiltersRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeSubscriptionFiltersResponse) => void): Request<CloudWatchLogs.Types.DescribeSubscriptionFiltersResponse, AWSError>; 186 /** 187 * Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name. 188 */ 189 describeSubscriptionFilters(callback?: (err: AWSError, data: CloudWatchLogs.Types.DescribeSubscriptionFiltersResponse) => void): Request<CloudWatchLogs.Types.DescribeSubscriptionFiltersResponse, AWSError>; 190 /** 191 * Disassociates the associated Key Management Service customer master key (CMK) from the specified log group. After the KMS CMK 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 CMK whenever the encrypted data is requested. Note that it can take up to 5 minutes for this operation to take effect. 192 */ 193 disassociateKmsKey(params: CloudWatchLogs.Types.DisassociateKmsKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 194 /** 195 * Disassociates the associated Key Management Service customer master key (CMK) from the specified log group. After the KMS CMK 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 CMK whenever the encrypted data is requested. Note that it can take up to 5 minutes for this operation to take effect. 196 */ 197 disassociateKmsKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 198 /** 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. 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 that you specify. If the results include a token, then there are more log events available, and 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. 200 */ 201 filterLogEvents(params: CloudWatchLogs.Types.FilterLogEventsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.FilterLogEventsResponse) => void): Request<CloudWatchLogs.Types.FilterLogEventsResponse, AWSError>; 202 /** 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. 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 that you specify. If the results include a token, then there are more log events available, and 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. 204 */ 205 filterLogEvents(callback?: (err: AWSError, data: CloudWatchLogs.Types.FilterLogEventsResponse) => void): Request<CloudWatchLogs.Types.FilterLogEventsResponse, AWSError>; 206 /** 207 * 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. 208 */ 209 getLogEvents(params: CloudWatchLogs.Types.GetLogEventsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogEventsResponse) => void): Request<CloudWatchLogs.Types.GetLogEventsResponse, AWSError>; 210 /** 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. 212 */ 213 getLogEvents(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogEventsResponse) => void): Request<CloudWatchLogs.Types.GetLogEventsResponse, AWSError>; 214 /** 215 * Returns a list of the fields that are included in log events in the specified log group, along with 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. 216 */ 217 getLogGroupFields(params: CloudWatchLogs.Types.GetLogGroupFieldsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogGroupFieldsResponse) => void): Request<CloudWatchLogs.Types.GetLogGroupFieldsResponse, AWSError>; 218 /** 219 * Returns a list of the fields that are included in log events in the specified log group, along with 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. 220 */ 221 getLogGroupFields(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogGroupFieldsResponse) => void): Request<CloudWatchLogs.Types.GetLogGroupFieldsResponse, AWSError>; 222 /** 223 * Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs. The full unparsed log event is returned within @message. 224 */ 225 getLogRecord(params: CloudWatchLogs.Types.GetLogRecordRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogRecordResponse) => void): Request<CloudWatchLogs.Types.GetLogRecordResponse, AWSError>; 226 /** 227 * Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs. The full unparsed log event is returned within @message. 228 */ 229 getLogRecord(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetLogRecordResponse) => void): Request<CloudWatchLogs.Types.GetLogRecordResponse, AWSError>; 230 /** 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 execution. 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. 232 */ 233 getQueryResults(params: CloudWatchLogs.Types.GetQueryResultsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.GetQueryResultsResponse) => void): Request<CloudWatchLogs.Types.GetQueryResultsResponse, AWSError>; 234 /** 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 execution. 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. 236 */ 237 getQueryResults(callback?: (err: AWSError, data: CloudWatchLogs.Types.GetQueryResultsResponse) => void): Request<CloudWatchLogs.Types.GetQueryResultsResponse, AWSError>; 238 /** 239 * Lists the tags for the specified log group. 240 */ 241 listTagsLogGroup(params: CloudWatchLogs.Types.ListTagsLogGroupRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.ListTagsLogGroupResponse) => void): Request<CloudWatchLogs.Types.ListTagsLogGroupResponse, AWSError>; 242 /** 243 * Lists the tags for the specified log group. 244 */ 245 listTagsLogGroup(callback?: (err: AWSError, data: CloudWatchLogs.Types.ListTagsLogGroupResponse) => void): Request<CloudWatchLogs.Types.ListTagsLogGroupResponse, AWSError>; 246 /** 247 * 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) and enables you to 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. 248 */ 249 putDestination(params: CloudWatchLogs.Types.PutDestinationRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutDestinationResponse) => void): Request<CloudWatchLogs.Types.PutDestinationResponse, AWSError>; 250 /** 251 * 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) and enables you to 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. 252 */ 253 putDestination(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutDestinationResponse) => void): Request<CloudWatchLogs.Types.PutDestinationResponse, AWSError>; 254 /** 255 * Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination. If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed separately in the policy. The policy does not support specifying * as the Principal or the use of the aws:PrincipalOrgId global key. 256 */ 257 putDestinationPolicy(params: CloudWatchLogs.Types.PutDestinationPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 258 /** 259 * Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination. If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed separately in the policy. The policy does not support specifying * as the Principal or the use of the aws:PrincipalOrgId global key. 260 */ 261 putDestinationPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 262 /** 263 * 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 older than 14 days or older 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 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 5 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 an invalid Amazon Web Services access key ID or secret key. 264 */ 265 putLogEvents(params: CloudWatchLogs.Types.PutLogEventsRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutLogEventsResponse) => void): Request<CloudWatchLogs.Types.PutLogEventsResponse, AWSError>; 266 /** 267 * 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 older than 14 days or older 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 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 5 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 an invalid Amazon Web Services access key ID or secret key. 268 */ 269 putLogEvents(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutLogEventsResponse) => void): Request<CloudWatchLogs.Types.PutLogEventsResponse, AWSError>; 270 /** 271 * Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to 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. To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time. 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. 272 */ 273 putMetricFilter(params: CloudWatchLogs.Types.PutMetricFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 274 /** 275 * Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to 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. To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time. 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. 276 */ 277 putMetricFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 278 /** 279 * 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, if you update a current query definition that includes log groups, and 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. 280 */ 281 putQueryDefinition(params: CloudWatchLogs.Types.PutQueryDefinitionRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutQueryDefinitionResponse) => void): Request<CloudWatchLogs.Types.PutQueryDefinitionResponse, AWSError>; 282 /** 283 * 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, if you update a current query definition that includes log groups, and 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. 284 */ 285 putQueryDefinition(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutQueryDefinitionResponse) => void): Request<CloudWatchLogs.Types.PutQueryDefinitionResponse, AWSError>; 286 /** 287 * Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region. 288 */ 289 putResourcePolicy(params: CloudWatchLogs.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.PutResourcePolicyResponse) => void): Request<CloudWatchLogs.Types.PutResourcePolicyResponse, AWSError>; 290 /** 291 * Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region. 292 */ 293 putResourcePolicy(callback?: (err: AWSError, data: CloudWatchLogs.Types.PutResourcePolicyResponse) => void): Request<CloudWatchLogs.Types.PutResourcePolicyResponse, AWSError>; 294 /** 295 * Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group. 296 */ 297 putRetentionPolicy(params: CloudWatchLogs.Types.PutRetentionPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 298 /** 299 * Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group. 300 */ 301 putRetentionPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 302 /** 303 * Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to 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 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 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. 304 */ 305 putSubscriptionFilter(params: CloudWatchLogs.Types.PutSubscriptionFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 306 /** 307 * Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to 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 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 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. 308 */ 309 putSubscriptionFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 310 /** 311 * 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 execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries. 312 */ 313 startQuery(params: CloudWatchLogs.Types.StartQueryRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.StartQueryResponse) => void): Request<CloudWatchLogs.Types.StartQueryResponse, AWSError>; 314 /** 315 * 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 execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries. 316 */ 317 startQuery(callback?: (err: AWSError, data: CloudWatchLogs.Types.StartQueryResponse) => void): Request<CloudWatchLogs.Types.StartQueryResponse, AWSError>; 318 /** 319 * Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running. 320 */ 321 stopQuery(params: CloudWatchLogs.Types.StopQueryRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.StopQueryResponse) => void): Request<CloudWatchLogs.Types.StopQueryResponse, AWSError>; 322 /** 323 * Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running. 324 */ 325 stopQuery(callback?: (err: AWSError, data: CloudWatchLogs.Types.StopQueryResponse) => void): Request<CloudWatchLogs.Types.StopQueryResponse, AWSError>; 326 /** 327 * Adds or updates the specified tags for the specified log group. To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup. For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide. CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags. 328 */ 329 tagLogGroup(params: CloudWatchLogs.Types.TagLogGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 330 /** 331 * Adds or updates the specified tags for the specified log group. To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup. For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide. CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags. 332 */ 333 tagLogGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 334 /** 335 * Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. 336 */ 337 testMetricFilter(params: CloudWatchLogs.Types.TestMetricFilterRequest, callback?: (err: AWSError, data: CloudWatchLogs.Types.TestMetricFilterResponse) => void): Request<CloudWatchLogs.Types.TestMetricFilterResponse, AWSError>; 338 /** 339 * Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. 340 */ 341 testMetricFilter(callback?: (err: AWSError, data: CloudWatchLogs.Types.TestMetricFilterResponse) => void): Request<CloudWatchLogs.Types.TestMetricFilterResponse, AWSError>; 342 /** 343 * Removes the specified tags from the specified log group. To list the tags for a log group, use ListTagsLogGroup. To add tags, use TagLogGroup. CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. 344 */ 345 untagLogGroup(params: CloudWatchLogs.Types.UntagLogGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 346 /** 347 * Removes the specified tags from the specified log group. To list the tags for a log group, use ListTagsLogGroup. To add tags, use TagLogGroup. CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. 348 */ 349 untagLogGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 350 } 351 declare namespace CloudWatchLogs { 352 export type AccessPolicy = string; 353 export type Arn = string; 354 export interface AssociateKmsKeyRequest { 355 /** 356 * The name of the log group. 357 */ 358 logGroupName: LogGroupName; 359 /** 360 * The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. This must be a symmetric CMK. For more information, see Amazon Resource Names - Key Management Service and Using Symmetric and Asymmetric Keys. 361 */ 362 kmsKeyId: KmsKeyId; 363 } 364 export interface CancelExportTaskRequest { 365 /** 366 * The ID of the export task. 367 */ 368 taskId: ExportTaskId; 369 } 370 export interface CreateExportTaskRequest { 371 /** 372 * The name of the export task. 373 */ 374 taskName?: ExportTaskName; 375 /** 376 * The name of the log group. 377 */ 378 logGroupName: LogGroupName; 379 /** 380 * Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied. 381 */ 382 logStreamNamePrefix?: LogStreamName; 383 /** 384 * The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported. 385 */ 386 from: Timestamp; 387 /** 388 * The end time of the range for the request, expreswatchlogsdocused as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported. 389 */ 390 to: Timestamp; 391 /** 392 * The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services region. 393 */ 394 destination: ExportDestinationBucket; 395 /** 396 * The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs. 397 */ 398 destinationPrefix?: ExportDestinationPrefix; 399 } 400 export interface CreateExportTaskResponse { 401 /** 402 * The ID of the export task. 403 */ 404 taskId?: ExportTaskId; 405 } 406 export interface CreateLogGroupRequest { 407 /** 408 * The name of the log group. 409 */ 410 logGroupName: LogGroupName; 411 /** 412 * The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - Key Management Service. 413 */ 414 kmsKeyId?: KmsKeyId; 415 /** 416 * The key-value pairs to use for the tags. CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags. 417 */ 418 tags?: Tags; 419 } 420 export interface CreateLogStreamRequest { 421 /** 422 * The name of the log group. 423 */ 424 logGroupName: LogGroupName; 425 /** 426 * The name of the log stream. 427 */ 428 logStreamName: LogStreamName; 429 } 430 export type Days = number; 431 export type DefaultValue = number; 432 export interface DeleteDestinationRequest { 433 /** 434 * The name of the destination. 435 */ 436 destinationName: DestinationName; 437 } 438 export interface DeleteLogGroupRequest { 439 /** 440 * The name of the log group. 441 */ 442 logGroupName: LogGroupName; 443 } 444 export interface DeleteLogStreamRequest { 445 /** 446 * The name of the log group. 447 */ 448 logGroupName: LogGroupName; 449 /** 450 * The name of the log stream. 451 */ 452 logStreamName: LogStreamName; 453 } 454 export interface DeleteMetricFilterRequest { 455 /** 456 * The name of the log group. 457 */ 458 logGroupName: LogGroupName; 459 /** 460 * The name of the metric filter. 461 */ 462 filterName: FilterName; 463 } 464 export interface DeleteQueryDefinitionRequest { 465 /** 466 * The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions. 467 */ 468 queryDefinitionId: QueryId; 469 } 470 export interface DeleteQueryDefinitionResponse { 471 /** 472 * A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation failed. 473 */ 474 success?: Success; 475 } 476 export interface DeleteResourcePolicyRequest { 477 /** 478 * The name of the policy to be revoked. This parameter is required. 479 */ 480 policyName?: PolicyName; 481 } 482 export interface DeleteRetentionPolicyRequest { 483 /** 484 * The name of the log group. 485 */ 486 logGroupName: LogGroupName; 487 } 488 export interface DeleteSubscriptionFilterRequest { 489 /** 490 * The name of the log group. 491 */ 492 logGroupName: LogGroupName; 493 /** 494 * The name of the subscription filter. 495 */ 496 filterName: FilterName; 497 } 498 export type Descending = boolean; 499 export interface DescribeDestinationsRequest { 500 /** 501 * The prefix to match. If you don't specify a value, no prefix filter is applied. 502 */ 503 DestinationNamePrefix?: DestinationName; 504 /** 505 * The token for the next set of items to return. (You received this token from a previous call.) 506 */ 507 nextToken?: NextToken; 508 /** 509 * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. 510 */ 511 limit?: DescribeLimit; 512 } 513 export interface DescribeDestinationsResponse { 514 /** 515 * The destinations. 516 */ 517 destinations?: Destinations; 518 nextToken?: NextToken; 519 } 520 export interface DescribeExportTasksRequest { 521 /** 522 * The ID of the export task. Specifying a task ID filters the results to zero or one export tasks. 523 */ 524 taskId?: ExportTaskId; 525 /** 526 * The status code of the export task. Specifying a status code filters the results to zero or more export tasks. 527 */ 528 statusCode?: ExportTaskStatusCode; 529 /** 530 * The token for the next set of items to return. (You received this token from a previous call.) 531 */ 532 nextToken?: NextToken; 533 /** 534 * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. 535 */ 536 limit?: DescribeLimit; 537 } 538 export interface DescribeExportTasksResponse { 539 /** 540 * The export tasks. 541 */ 542 exportTasks?: ExportTasks; 543 nextToken?: NextToken; 544 } 545 export type DescribeLimit = number; 546 export interface DescribeLogGroupsRequest { 547 /** 548 * The prefix to match. 549 */ 550 logGroupNamePrefix?: LogGroupName; 551 /** 552 * The token for the next set of items to return. (You received this token from a previous call.) 553 */ 554 nextToken?: NextToken; 555 /** 556 * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. 557 */ 558 limit?: DescribeLimit; 559 } 560 export interface DescribeLogGroupsResponse { 561 /** 562 * The log groups. If the retentionInDays value if not included for a log group, then that log group is set to have its events never expire. 563 */ 564 logGroups?: LogGroups; 565 nextToken?: NextToken; 566 } 567 export interface DescribeLogStreamsRequest { 568 /** 569 * The name of the log group. 570 */ 571 logGroupName: LogGroupName; 572 /** 573 * The prefix to match. If orderBy is LastEventTime, you cannot specify this parameter. 574 */ 575 logStreamNamePrefix?: LogStreamName; 576 /** 577 * If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName. If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer. 578 */ 579 orderBy?: OrderBy; 580 /** 581 * If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false. 582 */ 583 descending?: Descending; 584 /** 585 * The token for the next set of items to return. (You received this token from a previous call.) 586 */ 587 nextToken?: NextToken; 588 /** 589 * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. 590 */ 591 limit?: DescribeLimit; 592 } 593 export interface DescribeLogStreamsResponse { 594 /** 595 * The log streams. 596 */ 597 logStreams?: LogStreams; 598 nextToken?: NextToken; 599 } 600 export interface DescribeMetricFiltersRequest { 601 /** 602 * The name of the log group. 603 */ 604 logGroupName?: LogGroupName; 605 /** 606 * The prefix to match. CloudWatch Logs uses the value you set here only if you also include the logGroupName parameter in your request. 607 */ 608 filterNamePrefix?: FilterName; 609 /** 610 * The token for the next set of items to return. (You received this token from a previous call.) 611 */ 612 nextToken?: NextToken; 613 /** 614 * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. 615 */ 616 limit?: DescribeLimit; 617 /** 618 * Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter. 619 */ 620 metricName?: MetricName; 621 /** 622 * Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName parameter. 623 */ 624 metricNamespace?: MetricNamespace; 625 } 626 export interface DescribeMetricFiltersResponse { 627 /** 628 * The metric filters. 629 */ 630 metricFilters?: MetricFilters; 631 nextToken?: NextToken; 632 } 633 export type DescribeQueriesMaxResults = number; 634 export interface DescribeQueriesRequest { 635 /** 636 * Limits the returned queries to only those for the specified log group. 637 */ 638 logGroupName?: LogGroupName; 639 /** 640 * Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled. 641 */ 642 status?: QueryStatus; 643 /** 644 * Limits the number of returned queries to the specified number. 645 */ 646 maxResults?: DescribeQueriesMaxResults; 647 nextToken?: NextToken; 648 } 649 export interface DescribeQueriesResponse { 650 /** 651 * The list of queries that match the request. 652 */ 653 queries?: QueryInfoList; 654 nextToken?: NextToken; 655 } 656 export interface DescribeQueryDefinitionsRequest { 657 /** 658 * Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify. 659 */ 660 queryDefinitionNamePrefix?: QueryDefinitionName; 661 /** 662 * Limits the number of returned query definitions to the specified number. 663 */ 664 maxResults?: QueryListMaxResults; 665 nextToken?: NextToken; 666 } 667 export interface DescribeQueryDefinitionsResponse { 668 /** 669 * The list of query definitions that match your request. 670 */ 671 queryDefinitions?: QueryDefinitionList; 672 nextToken?: NextToken; 673 } 674 export interface DescribeResourcePoliciesRequest { 675 nextToken?: NextToken; 676 /** 677 * The maximum number of resource policies to be displayed with one call of this API. 678 */ 679 limit?: DescribeLimit; 680 } 681 export interface DescribeResourcePoliciesResponse { 682 /** 683 * The resource policies that exist in this account. 684 */ 685 resourcePolicies?: ResourcePolicies; 686 nextToken?: NextToken; 687 } 688 export interface DescribeSubscriptionFiltersRequest { 689 /** 690 * The name of the log group. 691 */ 692 logGroupName: LogGroupName; 693 /** 694 * The prefix to match. If you don't specify a value, no prefix filter is applied. 695 */ 696 filterNamePrefix?: FilterName; 697 /** 698 * The token for the next set of items to return. (You received this token from a previous call.) 699 */ 700 nextToken?: NextToken; 701 /** 702 * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. 703 */ 704 limit?: DescribeLimit; 705 } 706 export interface DescribeSubscriptionFiltersResponse { 707 /** 708 * The subscription filters. 709 */ 710 subscriptionFilters?: SubscriptionFilters; 711 nextToken?: NextToken; 712 } 713 export interface Destination { 714 /** 715 * The name of the destination. 716 */ 717 destinationName?: DestinationName; 718 /** 719 * The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream). 720 */ 721 targetArn?: TargetArn; 722 /** 723 * A role for impersonation, used when delivering log events to the target. 724 */ 725 roleArn?: RoleArn; 726 /** 727 * An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination. 728 */ 729 accessPolicy?: AccessPolicy; 730 /** 731 * The ARN of this destination. 732 */ 733 arn?: Arn; 734 /** 735 * The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 736 */ 737 creationTime?: Timestamp; 738 } 739 export type DestinationArn = string; 740 export type DestinationName = string; 741 export type Destinations = Destination[]; 742 export type Dimensions = {[key: string]: DimensionsValue}; 743 export type DimensionsKey = string; 744 export type DimensionsValue = string; 745 export interface DisassociateKmsKeyRequest { 746 /** 747 * The name of the log group. 748 */ 749 logGroupName: LogGroupName; 750 } 751 export type Distribution = "Random"|"ByLogStream"|string; 752 export type EventId = string; 753 export type EventMessage = string; 754 export type EventNumber = number; 755 export type EventsLimit = number; 756 export type ExportDestinationBucket = string; 757 export type ExportDestinationPrefix = string; 758 export interface ExportTask { 759 /** 760 * The ID of the export task. 761 */ 762 taskId?: ExportTaskId; 763 /** 764 * The name of the export task. 765 */ 766 taskName?: ExportTaskName; 767 /** 768 * The name of the log group from which logs data was exported. 769 */ 770 logGroupName?: LogGroupName; 771 /** 772 * The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not exported. 773 */ 774 from?: Timestamp; 775 /** 776 * The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported. 777 */ 778 to?: Timestamp; 779 /** 780 * The name of the S3 bucket to which the log data was exported. 781 */ 782 destination?: ExportDestinationBucket; 783 /** 784 * The prefix that was used as the start of Amazon S3 key for every object exported. 785 */ 786 destinationPrefix?: ExportDestinationPrefix; 787 /** 788 * The status of the export task. 789 */ 790 status?: ExportTaskStatus; 791 /** 792 * Execution information about the export task. 793 */ 794 executionInfo?: ExportTaskExecutionInfo; 795 } 796 export interface ExportTaskExecutionInfo { 797 /** 798 * The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 799 */ 800 creationTime?: Timestamp; 801 /** 802 * The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 803 */ 804 completionTime?: Timestamp; 805 } 806 export type ExportTaskId = string; 807 export type ExportTaskName = string; 808 export interface ExportTaskStatus { 809 /** 810 * The status code of the export task. 811 */ 812 code?: ExportTaskStatusCode; 813 /** 814 * The status message related to the status code. 815 */ 816 message?: ExportTaskStatusMessage; 817 } 818 export type ExportTaskStatusCode = "CANCELLED"|"COMPLETED"|"FAILED"|"PENDING"|"PENDING_CANCEL"|"RUNNING"|string; 819 export type ExportTaskStatusMessage = string; 820 export type ExportTasks = ExportTask[]; 821 export type ExtractedValues = {[key: string]: Value}; 822 export type Field = string; 823 export type FilterCount = number; 824 export interface FilterLogEventsRequest { 825 /** 826 * The name of the log group to search. 827 */ 828 logGroupName: LogGroupName; 829 /** 830 * 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. 831 */ 832 logStreamNames?: InputLogStreamNames; 833 /** 834 * Filters the results to include only events from log streams that have names starting with this prefix. If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error. 835 */ 836 logStreamNamePrefix?: LogStreamName; 837 /** 838 * The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned. 839 */ 840 startTime?: Timestamp; 841 /** 842 * The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned. 843 */ 844 endTime?: Timestamp; 845 /** 846 * The filter pattern to use. For more information, see Filter and Pattern Syntax. If not provided, all the events are matched. 847 */ 848 filterPattern?: FilterPattern; 849 /** 850 * The token for the next set of events to return. (You received this token from a previous call.) 851 */ 852 nextToken?: NextToken; 853 /** 854 * The maximum number of events to return. The default is 10,000 events. 855 */ 856 limit?: EventsLimit; 857 /** 858 * If the value is true, the operation makes a best effort 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. The default is false. Important: Starting on 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. 859 */ 860 interleaved?: Interleaved; 861 } 862 export interface FilterLogEventsResponse { 863 /** 864 * The matched events. 865 */ 866 events?: FilteredLogEvents; 867 /** 868 * IMPORTANT Starting on May 15, 2020, this parameter will be deprecated. This parameter will be an empty list after the deprecation occurs. Indicates which log streams have been searched and whether each has been searched completely. 869 */ 870 searchedLogStreams?: SearchedLogStreams; 871 /** 872 * The token to use when requesting the next set of items. The token expires after 24 hours. 873 */ 874 nextToken?: NextToken; 875 } 876 export type FilterName = string; 877 export type FilterPattern = string; 878 export interface FilteredLogEvent { 879 /** 880 * The name of the log stream to which this event belongs. 881 */ 882 logStreamName?: LogStreamName; 883 /** 884 * The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 885 */ 886 timestamp?: Timestamp; 887 /** 888 * The data contained in the log event. 889 */ 890 message?: EventMessage; 891 /** 892 * The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 893 */ 894 ingestionTime?: Timestamp; 895 /** 896 * The ID of the event. 897 */ 898 eventId?: EventId; 899 } 900 export type FilteredLogEvents = FilteredLogEvent[]; 901 export interface GetLogEventsRequest { 902 /** 903 * The name of the log group. 904 */ 905 logGroupName: LogGroupName; 906 /** 907 * The name of the log stream. 908 */ 909 logStreamName: LogStreamName; 910 /** 911 * The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included. 912 */ 913 startTime?: Timestamp; 914 /** 915 * The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included. 916 */ 917 endTime?: Timestamp; 918 /** 919 * The token for the next set of items to return. (You received this token from a previous call.) 920 */ 921 nextToken?: NextToken; 922 /** 923 * The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events. 924 */ 925 limit?: EventsLimit; 926 /** 927 * 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. 928 */ 929 startFromHead?: StartFromHead; 930 } 931 export interface GetLogEventsResponse { 932 /** 933 * The events. 934 */ 935 events?: OutputLogEvents; 936 /** 937 * The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it returns the same token you passed in. 938 */ 939 nextForwardToken?: NextToken; 940 /** 941 * The token for the next set of items in the backward direction. The token expires after 24 hours. This token is never null. If you have reached the end of the stream, it returns the same token you passed in. 942 */ 943 nextBackwardToken?: NextToken; 944 } 945 export interface GetLogGroupFieldsRequest { 946 /** 947 * The name of the log group to search. 948 */ 949 logGroupName: LogGroupName; 950 /** 951 * 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. 952 */ 953 time?: Timestamp; 954 } 955 export interface GetLogGroupFieldsResponse { 956 /** 957 * The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried. 958 */ 959 logGroupFields?: LogGroupFieldList; 960 } 961 export interface GetLogRecordRequest { 962 /** 963 * 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. 964 */ 965 logRecordPointer: LogRecordPointer; 966 } 967 export interface GetLogRecordResponse { 968 /** 969 * The requested log event, as a JSON string. 970 */ 971 logRecord?: LogRecord; 972 } 973 export interface GetQueryResultsRequest { 974 /** 975 * The ID number of the query. 976 */ 977 queryId: QueryId; 978 } 979 export interface GetQueryResultsResponse { 980 /** 981 * The log events that matched the query criteria during the most recent time it ran. The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs. 982 */ 983 results?: QueryResults; 984 /** 985 * Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned. These values reflect the full raw results of the query. 986 */ 987 statistics?: QueryStatistics; 988 /** 989 * 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 execution. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries. 990 */ 991 status?: QueryStatus; 992 } 993 export interface InputLogEvent { 994 /** 995 * The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 996 */ 997 timestamp: Timestamp; 998 /** 999 * The raw event message. 1000 */ 1001 message: EventMessage; 1002 } 1003 export type InputLogEvents = InputLogEvent[]; 1004 export type InputLogStreamNames = LogStreamName[]; 1005 export type Interleaved = boolean; 1006 export type KmsKeyId = string; 1007 export interface ListTagsLogGroupRequest { 1008 /** 1009 * The name of the log group. 1010 */ 1011 logGroupName: LogGroupName; 1012 } 1013 export interface ListTagsLogGroupResponse { 1014 /** 1015 * The tags for the log group. 1016 */ 1017 tags?: Tags; 1018 } 1019 export type LogEventIndex = number; 1020 export interface LogGroup { 1021 /** 1022 * The name of the log group. 1023 */ 1024 logGroupName?: LogGroupName; 1025 /** 1026 * The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 1027 */ 1028 creationTime?: Timestamp; 1029 retentionInDays?: Days; 1030 /** 1031 * The number of metric filters. 1032 */ 1033 metricFilterCount?: FilterCount; 1034 /** 1035 * The Amazon Resource Name (ARN) of the log group. 1036 */ 1037 arn?: Arn; 1038 /** 1039 * The number of bytes stored. 1040 */ 1041 storedBytes?: StoredBytes; 1042 /** 1043 * The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. 1044 */ 1045 kmsKeyId?: KmsKeyId; 1046 } 1047 export interface LogGroupField { 1048 /** 1049 * The name of a log field. 1050 */ 1051 name?: Field; 1052 /** 1053 * The percentage of log events queried that contained the field. 1054 */ 1055 percent?: Percentage; 1056 } 1057 export type LogGroupFieldList = LogGroupField[]; 1058 export type LogGroupName = string; 1059 export type LogGroupNames = LogGroupName[]; 1060 export type LogGroups = LogGroup[]; 1061 export type LogRecord = {[key: string]: Value}; 1062 export type LogRecordPointer = string; 1063 export interface LogStream { 1064 /** 1065 * The name of the log stream. 1066 */ 1067 logStreamName?: LogStreamName; 1068 /** 1069 * The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 1070 */ 1071 creationTime?: Timestamp; 1072 /** 1073 * The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 1074 */ 1075 firstEventTimestamp?: Timestamp; 1076 /** 1077 * The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer. 1078 */ 1079 lastEventTimestamp?: Timestamp; 1080 /** 1081 * The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 1082 */ 1083 lastIngestionTime?: Timestamp; 1084 /** 1085 * The sequence token. 1086 */ 1087 uploadSequenceToken?: SequenceToken; 1088 /** 1089 * The Amazon Resource Name (ARN) of the log stream. 1090 */ 1091 arn?: Arn; 1092 /** 1093 * The number of bytes stored. Important: On June 17, 2019, this parameter was deprecated 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. 1094 */ 1095 storedBytes?: StoredBytes; 1096 } 1097 export type LogStreamName = string; 1098 export type LogStreamSearchedCompletely = boolean; 1099 export type LogStreams = LogStream[]; 1100 export interface MetricFilter { 1101 /** 1102 * The name of the metric filter. 1103 */ 1104 filterName?: FilterName; 1105 filterPattern?: FilterPattern; 1106 /** 1107 * The metric transformations. 1108 */ 1109 metricTransformations?: MetricTransformations; 1110 /** 1111 * The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 1112 */ 1113 creationTime?: Timestamp; 1114 /** 1115 * The name of the log group. 1116 */ 1117 logGroupName?: LogGroupName; 1118 } 1119 export interface MetricFilterMatchRecord { 1120 /** 1121 * The event number. 1122 */ 1123 eventNumber?: EventNumber; 1124 /** 1125 * The raw event data. 1126 */ 1127 eventMessage?: EventMessage; 1128 /** 1129 * The values extracted from the event data by the filter. 1130 */ 1131 extractedValues?: ExtractedValues; 1132 } 1133 export type MetricFilterMatches = MetricFilterMatchRecord[]; 1134 export type MetricFilters = MetricFilter[]; 1135 export type MetricName = string; 1136 export type MetricNamespace = string; 1137 export interface MetricTransformation { 1138 /** 1139 * The name of the CloudWatch metric. 1140 */ 1141 metricName: MetricName; 1142 /** 1143 * A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces. 1144 */ 1145 metricNamespace: MetricNamespace; 1146 /** 1147 * The value to publish to the CloudWatch metric when a filter pattern matches a log event. 1148 */ 1149 metricValue: MetricValue; 1150 /** 1151 * (Optional) The value to emit when a filter pattern does not match a log event. This value can be null. 1152 */ 1153 defaultValue?: DefaultValue; 1154 /** 1155 * 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. To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time. 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. 1156 */ 1157 dimensions?: Dimensions; 1158 /** 1159 * The unit to assign to the metric. If you omit this, the unit is set as None. 1160 */ 1161 unit?: StandardUnit; 1162 } 1163 export type MetricTransformations = MetricTransformation[]; 1164 export type MetricValue = string; 1165 export type NextToken = string; 1166 export type OrderBy = "LogStreamName"|"LastEventTime"|string; 1167 export interface OutputLogEvent { 1168 /** 1169 * The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 1170 */ 1171 timestamp?: Timestamp; 1172 /** 1173 * The data contained in the log event. 1174 */ 1175 message?: EventMessage; 1176 /** 1177 * The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 1178 */ 1179 ingestionTime?: Timestamp; 1180 } 1181 export type OutputLogEvents = OutputLogEvent[]; 1182 export type Percentage = number; 1183 export type PolicyDocument = string; 1184 export type PolicyName = string; 1185 export interface PutDestinationPolicyRequest { 1186 /** 1187 * A name for an existing destination. 1188 */ 1189 destinationName: DestinationName; 1190 /** 1191 * An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes. 1192 */ 1193 accessPolicy: AccessPolicy; 1194 } 1195 export interface PutDestinationRequest { 1196 /** 1197 * A name for the destination. 1198 */ 1199 destinationName: DestinationName; 1200 /** 1201 * The ARN of an Amazon Kinesis stream to which to deliver matching log events. 1202 */ 1203 targetArn: TargetArn; 1204 /** 1205 * The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream. 1206 */ 1207 roleArn: RoleArn; 1208 } 1209 export interface PutDestinationResponse { 1210 /** 1211 * The destination. 1212 */ 1213 destination?: Destination; 1214 } 1215 export interface PutLogEventsRequest { 1216 /** 1217 * The name of the log group. 1218 */ 1219 logGroupName: LogGroupName; 1220 /** 1221 * The name of the log stream. 1222 */ 1223 logStreamName: LogStreamName; 1224 /** 1225 * The log events. 1226 */ 1227 logEvents: InputLogEvents; 1228 /** 1229 * The sequence token obtained from the response of the previous PutLogEvents call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. 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. 1230 */ 1231 sequenceToken?: SequenceToken; 1232 } 1233 export interface PutLogEventsResponse { 1234 /** 1235 * The next sequence token. 1236 */ 1237 nextSequenceToken?: SequenceToken; 1238 /** 1239 * The rejected events. 1240 */ 1241 rejectedLogEventsInfo?: RejectedLogEventsInfo; 1242 } 1243 export interface PutMetricFilterRequest { 1244 /** 1245 * The name of the log group. 1246 */ 1247 logGroupName: LogGroupName; 1248 /** 1249 * A name for the metric filter. 1250 */ 1251 filterName: FilterName; 1252 /** 1253 * A filter pattern for extracting metric data out of ingested log events. 1254 */ 1255 filterPattern: FilterPattern; 1256 /** 1257 * A collection of information that defines how metric data gets emitted. 1258 */ 1259 metricTransformations: MetricTransformations; 1260 } 1261 export interface PutQueryDefinitionRequest { 1262 /** 1263 * A name for the query definition. If you are saving a lot of query definitions, we recommend that you name them so that you can easily find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions. 1264 */ 1265 name: QueryDefinitionName; 1266 /** 1267 * If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions. If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation. 1268 */ 1269 queryDefinitionId?: QueryId; 1270 /** 1271 * Use this parameter to include specific log groups as part of your query definition. If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups. 1272 */ 1273 logGroupNames?: LogGroupNames; 1274 /** 1275 * The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax. 1276 */ 1277 queryString: QueryDefinitionString; 1278 } 1279 export interface PutQueryDefinitionResponse { 1280 /** 1281 * The ID of the query definition. 1282 */ 1283 queryDefinitionId?: QueryId; 1284 } 1285 export interface PutResourcePolicyRequest { 1286 /** 1287 * Name of the new policy. This parameter is required. 1288 */ 1289 policyName?: PolicyName; 1290 /** 1291 * 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 and 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" } } } ] } 1292 */ 1293 policyDocument?: PolicyDocument; 1294 } 1295 export interface PutResourcePolicyResponse { 1296 /** 1297 * The new policy. 1298 */ 1299 resourcePolicy?: ResourcePolicy; 1300 } 1301 export interface PutRetentionPolicyRequest { 1302 /** 1303 * The name of the log group. 1304 */ 1305 logGroupName: LogGroupName; 1306 retentionInDays: Days; 1307 } 1308 export interface PutSubscriptionFilterRequest { 1309 /** 1310 * The name of the log group. 1311 */ 1312 logGroupName: LogGroupName; 1313 /** 1314 * A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters. 1315 */ 1316 filterName: FilterName; 1317 /** 1318 * A filter pattern for subscribing to a filtered stream of log events. 1319 */ 1320 filterPattern: FilterPattern; 1321 /** 1322 * 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 are setting up a cross-account subscription, the destination must have an IAM policy associated with it that allows the sender to send logs to the destination. For more information, see PutDestinationPolicy. An Amazon Kinesis 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. 1323 */ 1324 destinationArn: DestinationArn; 1325 /** 1326 * The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. 1327 */ 1328 roleArn?: RoleArn; 1329 /** 1330 * 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. 1331 */ 1332 distribution?: Distribution; 1333 } 1334 export interface QueryDefinition { 1335 /** 1336 * The unique ID of the query definition. 1337 */ 1338 queryDefinitionId?: QueryId; 1339 /** 1340 * The name of the query definition. 1341 */ 1342 name?: QueryDefinitionName; 1343 /** 1344 * The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax. 1345 */ 1346 queryString?: QueryDefinitionString; 1347 /** 1348 * The date that the query definition was most recently modified. 1349 */ 1350 lastModified?: Timestamp; 1351 /** 1352 * If this query definition contains a list of log groups that it is limited to, that list appears here. 1353 */ 1354 logGroupNames?: LogGroupNames; 1355 } 1356 export type QueryDefinitionList = QueryDefinition[]; 1357 export type QueryDefinitionName = string; 1358 export type QueryDefinitionString = string; 1359 export type QueryId = string; 1360 export interface QueryInfo { 1361 /** 1362 * The unique ID number of this query. 1363 */ 1364 queryId?: QueryId; 1365 /** 1366 * The query string used in this query. 1367 */ 1368 queryString?: QueryString; 1369 /** 1370 * The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown. 1371 */ 1372 status?: QueryStatus; 1373 /** 1374 * The date and time that this query was created. 1375 */ 1376 createTime?: Timestamp; 1377 /** 1378 * The name of the log group scanned by this query. 1379 */ 1380 logGroupName?: LogGroupName; 1381 } 1382 export type QueryInfoList = QueryInfo[]; 1383 export type QueryListMaxResults = number; 1384 export type QueryResults = ResultRows[]; 1385 export interface QueryStatistics { 1386 /** 1387 * The number of log events that matched the query string. 1388 */ 1389 recordsMatched?: StatsValue; 1390 /** 1391 * The total number of log events scanned during the query. 1392 */ 1393 recordsScanned?: StatsValue; 1394 /** 1395 * The total number of bytes in the log events scanned during the query. 1396 */ 1397 bytesScanned?: StatsValue; 1398 } 1399 export type QueryStatus = "Scheduled"|"Running"|"Complete"|"Failed"|"Cancelled"|"Timeout"|"Unknown"|string; 1400 export type QueryString = string; 1401 export interface RejectedLogEventsInfo { 1402 /** 1403 * The log events that are too new. 1404 */ 1405 tooNewLogEventStartIndex?: LogEventIndex; 1406 /** 1407 * The log events that are too old. 1408 */ 1409 tooOldLogEventEndIndex?: LogEventIndex; 1410 /** 1411 * The expired log events. 1412 */ 1413 expiredLogEventEndIndex?: LogEventIndex; 1414 } 1415 export type ResourcePolicies = ResourcePolicy[]; 1416 export interface ResourcePolicy { 1417 /** 1418 * The name of the resource policy. 1419 */ 1420 policyName?: PolicyName; 1421 /** 1422 * The details of the policy. 1423 */ 1424 policyDocument?: PolicyDocument; 1425 /** 1426 * Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 1427 */ 1428 lastUpdatedTime?: Timestamp; 1429 } 1430 export interface ResultField { 1431 /** 1432 * The log event field. 1433 */ 1434 field?: Field; 1435 /** 1436 * The value of this field. 1437 */ 1438 value?: Value; 1439 } 1440 export type ResultRows = ResultField[]; 1441 export type RoleArn = string; 1442 export interface SearchedLogStream { 1443 /** 1444 * The name of the log stream. 1445 */ 1446 logStreamName?: LogStreamName; 1447 /** 1448 * Indicates whether all the events in this log stream were searched. 1449 */ 1450 searchedCompletely?: LogStreamSearchedCompletely; 1451 } 1452 export type SearchedLogStreams = SearchedLogStream[]; 1453 export type SequenceToken = string; 1454 export type StandardUnit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"|string; 1455 export type StartFromHead = boolean; 1456 export interface StartQueryRequest { 1457 /** 1458 * The log group on which to perform the query. A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both. 1459 */ 1460 logGroupName?: LogGroupName; 1461 /** 1462 * The list of log groups to be queried. You can include up to 20 log groups. A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both. 1463 */ 1464 logGroupNames?: LogGroupNames; 1465 /** 1466 * 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. 1467 */ 1468 startTime: Timestamp; 1469 /** 1470 * The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC. 1471 */ 1472 endTime: Timestamp; 1473 /** 1474 * The query string to use. For more information, see CloudWatch Logs Insights Query Syntax. 1475 */ 1476 queryString: QueryString; 1477 /** 1478 * The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000. 1479 */ 1480 limit?: EventsLimit; 1481 } 1482 export interface StartQueryResponse { 1483 /** 1484 * The unique ID of the query. 1485 */ 1486 queryId?: QueryId; 1487 } 1488 export type StatsValue = number; 1489 export interface StopQueryRequest { 1490 /** 1491 * The ID number of the query to stop. To find this ID number, use DescribeQueries. 1492 */ 1493 queryId: QueryId; 1494 } 1495 export interface StopQueryResponse { 1496 /** 1497 * This is true if the query was stopped by the StopQuery operation. 1498 */ 1499 success?: Success; 1500 } 1501 export type StoredBytes = number; 1502 export interface SubscriptionFilter { 1503 /** 1504 * The name of the subscription filter. 1505 */ 1506 filterName?: FilterName; 1507 /** 1508 * The name of the log group. 1509 */ 1510 logGroupName?: LogGroupName; 1511 filterPattern?: FilterPattern; 1512 /** 1513 * The Amazon Resource Name (ARN) of the destination. 1514 */ 1515 destinationArn?: DestinationArn; 1516 /** 1517 * 1518 */ 1519 roleArn?: RoleArn; 1520 distribution?: Distribution; 1521 /** 1522 * The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. 1523 */ 1524 creationTime?: Timestamp; 1525 } 1526 export type SubscriptionFilters = SubscriptionFilter[]; 1527 export type Success = boolean; 1528 export type TagKey = string; 1529 export type TagList = TagKey[]; 1530 export interface TagLogGroupRequest { 1531 /** 1532 * The name of the log group. 1533 */ 1534 logGroupName: LogGroupName; 1535 /** 1536 * The key-value pairs to use for the tags. 1537 */ 1538 tags: Tags; 1539 } 1540 export type TagValue = string; 1541 export type Tags = {[key: string]: TagValue}; 1542 export type TargetArn = string; 1543 export type TestEventMessages = EventMessage[]; 1544 export interface TestMetricFilterRequest { 1545 filterPattern: FilterPattern; 1546 /** 1547 * The log event messages to test. 1548 */ 1549 logEventMessages: TestEventMessages; 1550 } 1551 export interface TestMetricFilterResponse { 1552 /** 1553 * The matched events. 1554 */ 1555 matches?: MetricFilterMatches; 1556 } 1557 export type Timestamp = number; 1558 export type Token = string; 1559 export interface UntagLogGroupRequest { 1560 /** 1561 * The name of the log group. 1562 */ 1563 logGroupName: LogGroupName; 1564 /** 1565 * The tag keys. The corresponding tags are removed from the log group. 1566 */ 1567 tags: TagList; 1568 } 1569 export type Value = string; 1570 /** 1571 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1572 */ 1573 export type apiVersion = "2014-03-28"|"latest"|string; 1574 export interface ClientApiVersions { 1575 /** 1576 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1577 */ 1578 apiVersion?: apiVersion; 1579 } 1580 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1581 /** 1582 * Contains interfaces for use with the CloudWatchLogs client. 1583 */ 1584 export import Types = CloudWatchLogs; 1585 } 1586 export = CloudWatchLogs;