QueryDefinition
This structure contains details about a saved CloudWatch Logs Insights query definition.
Contents
lastModified
The date that the query definition was most recently modified.
Type: Long
Valid Range: Minimum value of 0.
Required: No logGroupNames
If this query definition contains a list of log groups that it is limited to, that list appears here.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: [\.\-_/#A-Za-z0-9]+
Required: No name
The name of the query definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^([^:*\/]+\/?)*[^:*\/]+$
Required: No queryDefinitionId
The unique ID of the query definition.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No queryString
The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10000.
Required: No
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
QueryInfo
QueryInfo
Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.
Contents
createTime
The date and time that this query was created.
Type: Long
Valid Range: Minimum value of 0.
Required: No logGroupName
The name of the log group scanned by this query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: [\.\-_/#A-Za-z0-9]+
Required: No queryId
The unique ID number of this query.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No queryString
The query string used in this query.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10000.
Required: No status
The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.
Type: String
Valid Values: Scheduled | Running | Complete | Failed | Cancelled | Timeout | Unknown
Required: No
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
QueryStatistics
QueryStatistics
Contains 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.
Contents
bytesScanned
The total number of bytes in the log events scanned during the query.
Type: Double Required: No recordsMatched
The number of log events that matched the query string.
Type: Double Required: No recordsScanned
The total number of log events scanned during the query.
Type: Double Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
RejectedLogEventsInfo
RejectedLogEventsInfo
Represents the rejected events.
Contents
expiredLogEventEndIndex The expired log events.
Type: Integer Required: No
tooNewLogEventStartIndex The log events that are too new.
Type: Integer Required: No
tooOldLogEventEndIndex
The log events that are too old.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResourcePolicy
ResourcePolicy
A policy enabling one or more entities to put logs to a log group in this account.
Contents
lastUpdatedTime
Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Type: Long
Valid Range: Minimum value of 0.
Required: No policyDocument
The details of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5120.
Required: No policyName
The name of the resource policy.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResultField
ResultField
Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.
For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.
Contents
field
The log event field.
Type: String Required: No value
The value of this field.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SearchedLogStream
SearchedLogStream
Represents the search status of a log stream.
Contents
logStreamName
The name of the log stream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: [^:*]*
Required: No searchedCompletely
Indicates whether all the events in this log stream were searched.
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SubscriptionFilter
SubscriptionFilter
Represents a subscription filter.
Contents
creationTime
The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Type: Long
Valid Range: Minimum value of 0.
Required: No destinationArn
The Amazon Resource Name (ARN) of the destination.
Type: String
Length Constraints: Minimum length of 1.
Required: No distribution
The method used to distribute log data to the destination, which can be either random or grouped by log stream.
Type: String
Valid Values: Random | ByLogStream Required: No
filterName
The name of the subscription filter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: [^:*]*
Required: No filterPattern
A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
See Also
logGroupName
The name of the log group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: [\.\-_/#A-Za-z0-9]+
Required: No roleArn
Type: String
Length Constraints: Minimum length of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CloudWatch Logs Endpoints