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.

The name of the log group to search.

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.

The response's http status code.

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.

The requested log event, as a JSON string.

The response's http status code.

The token for the next set of items to return. (You received this token from a previous call.)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

The prefix to match. If you don't specify a value, no prefix filter is applied.

Undocumented member.

The destinations.

The response's http status code.

The name of the log group.

The tag keys. The corresponding tags are removed from the log group.

The ID number of the query to stop. To find this ID number, use DescribeQueries.

This is true if the query was stopped by the StopQuery operation.

The response's http status code.

The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.

The name of the export task.

Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

The name of the log group.

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.

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.

The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services region.

The ID of the export task.

The response's http status code.

A name for the destination.

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

The destination.

The response's http status code.

The prefix to match. If you don't specify a value, no prefix filter is applied.

The token for the next set of items to return. (You received this token from a previous call.)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

The name of the log group.

The subscription filters.

Undocumented member.

The response's http status code.

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.

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.

The token for the next set of items to return. (You received this token from a previous call.)

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.

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.

The name of the log group.

The name of the log stream.

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.

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.

The events.

The response's http status code.

The prefix to match.

The token for the next set of items to return. (You received this token from a previous call.)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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.

Undocumented member.

The response's http status code.

The name of the destination.

The name of the log group.

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.

The token for the next set of events to return. (You received this token from a previous call.)

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.

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.

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.

The maximum number of events to return. The default is 10,000 events.

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

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.

The name of the log group to search.

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.

The token to use when requesting the next set of items. The token expires after 24 hours.

The matched events.

The response's http status code.

The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation failed.

The response's http status code.

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.

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.

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.

The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.

The ID of the query definition.

The response's http status code.

The name of the log group.

The key-value pairs to use for the tags.

Undocumented member.

The maximum number of resource policies to be displayed with one call of this API.

The resource policies that exist in this account.

Undocumented member.

The response's http status code.

Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.

Undocumented member.

Limits the number of returned query definitions to the specified number.

The list of query definitions that match your request.

Undocumented member.

The response's http status code.

The name of the log group.

The name of the log stream.

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

Limits the returned queries to only those for the specified log group.

Undocumented member.

Limits the number of returned queries to the specified number.

The list of queries that match the request.

Undocumented member.

The response's http status code.

The name of the log group.

The name of the log stream.

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - Key Management Service.

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.

The name of the log group.

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

The token for the next set of items to return. (You received this token from a previous call.)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Undocumented member.

The export tasks.

The response's http status code.

The ID of the export task.

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.

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.

The name of the log group.

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.

A filter pattern for subscribing to a filtered stream of log events.

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.

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.

The log group on which to perform the query.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

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.

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.

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.

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

The unique ID of the query.

The response's http status code.

The name of the log group.

The name of the log group.

The name of the subscription filter.

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.

The name of the log group.

The name of the log stream.

The log events.

The rejected events.

The next sequence token.

The response's http status code.

The prefix to match. CloudWatch Logs uses the value you set here only if you also include the logGroupName parameter in your request.

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.

The name of the log group.

The token for the next set of items to return. (You received this token from a previous call.)

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.

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Undocumented member.

The metric filters.

The response's http status code.

Undocumented member.

The log event messages to test.

The matched events.

The response's http status code.

A name for an existing destination.

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.

The name of the log group.

A name for the metric filter.

A filter pattern for extracting metric data out of ingested log events.

A collection of information that defines how metric data gets emitted.

The name of the log group.

The name of the log group.

The name of the metric filter.

The name of the log group.

Undocumented member.

The name of the log group.

The tags for the log group.

The response's http status code.

Name of the new policy. This parameter is required.

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" } } } ] }

The new policy.

The response's http status code.

The name of the policy to be revoked. This parameter is required.

The name of the log group.

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.

The ID number of the query.

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.

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.

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.

The response's http status code.

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.

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.

The token for the next set of items to return. (You received this token from a previous call.)

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

The name of the log group.

Undocumented member.

The log streams.

The response's http status code.

The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The ARN of this destination.

An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination.

The name of the destination.

A role for impersonation, used when delivering log events to the target.

The prefix that was used as the start of Amazon S3 key for every object exported.

The name of the S3 bucket to which the log data was exported.

The status of the export task.

The name of the export task.

The ID of the export task.

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.

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.

The name of the log group from which logs data was exported.

Execution information about the export task.

The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The status code of the export task.

The status message related to the status code.

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The name of the log stream to which this event belongs.

The data contained in the log event.

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The ID of the event.

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The raw event message.

The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The number of metric filters.

The Amazon Resource Name (ARN) of the log group.

The name of the log group.

Undocumented member.

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.

The number of bytes stored.

The percentage of log events queried that contained the field.

The name of a log field.

The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The sequence token.

The Amazon Resource Name (ARN) of the log stream.

The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The name of the log stream.

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.

The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

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.

The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The name of the metric filter.

The name of the log group.

Undocumented member.

The metric transformations.

The values extracted from the event data by the filter.

The event number.

The raw event data.

(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

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.

The unit to assign to the metric. If you omit this, the unit is set as None.

The name of the CloudWatch metric.

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The data contained in the log event.

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

If this query definition contains a list of log groups that it is limited to, that list appears here.

The unique ID of the query definition.

The name of the query definition.

The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.

The date that the query definition was most recently modified.

The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

The unique ID number of this query.

The name of the log group scanned by this query.

The query string used in this query.

The date and time that this query was created.

The total number of log events scanned during the query.

The total number of bytes in the log events scanned during the query.

The number of log events that matched the query string.

The log events that are too old.

The log events that are too new.

The expired log events.

The name of the resource policy.

The details of the policy.

Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The log event field.

The value of this field.

The name of the log stream.

Indicates whether all the events in this log stream were searched.

The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

The name of the subscription filter.

Undocumented member.

The Amazon Resource Name (ARN) of the destination.

The name of the log group.

Undocumented member.