aws-sdk-cloudwatchlogs 1.11.0 → 1.12.0

data/lib/aws-sdk-cloudwatchlogs/types.rb

@@ -84,14 +84,14 @@ module Aws::CloudWatchLogs
     #
     # @!attribute [rw] from
     #   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 time
-    #   stamp earlier than this time are not exported.
+    #   of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
+    #   timestamp earlier than this time are not exported.
     #   @return [Integer]
     #
     # @!attribute [rw] to
     #   The end time of the range for the request, expressed as the number
-    #   of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time
-    #   stamp later than this time are not exported.
+    #   of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
+    #   timestamp later than this time are not exported.
     #   @return [Integer]
     #
     # @!attribute [rw] destination
@@ -644,6 +644,63 @@ module Aws::CloudWatchLogs
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DescribeQueriesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         log_group_name: "LogGroupName",
+    #         status: "Scheduled", # accepts Scheduled, Running, Complete, Failed, Cancelled
+    #         max_results: 1,
+    #         next_token: "NextToken",
+    #       }
+    #
+    # @!attribute [rw] log_group_name
+    #   Limits the returned queries to only those for the specified log
+    #   group.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   Limits the returned queries to only those that have the specified
+    #   status. Valid values are `Cancelled`, `Complete`, `Failed`,
+    #   `Running`, and `Scheduled`.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   Limits the number of returned queries to the specified number.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of items to return. The token expires
+    #   after 24 hours.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueriesRequest AWS API Documentation
+    #
+    class DescribeQueriesRequest < Struct.new(
+      :log_group_name,
+      :status,
+      :max_results,
+      :next_token)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] queries
+    #   The list of queries that match the request.
+    #   @return [Array<Types::QueryInfo>]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of items to return. The token expires
+    #   after 24 hours.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueriesResponse AWS API Documentation
+    #
+    class DescribeQueriesResponse < Struct.new(
+      :queries,
+      :next_token)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeResourcePoliciesRequest
     #   data as a hash:
     #
@@ -820,13 +877,13 @@ module Aws::CloudWatchLogs
     #
     # @!attribute [rw] from
     #   The start time, expressed as the number of milliseconds after Jan 1,
-    #   1970 00:00:00 UTC. Events with a time stamp before this time are not
+    #   1970 00:00:00 UTC. Events with a timestamp before this time are not
     #   exported.
     #   @return [Integer]
     #
     # @!attribute [rw] to
     #   The end time, expressed as the number of milliseconds after Jan 1,
-    #   1970 00:00:00 UTC. Events with a time stamp later than this time are
+    #   1970 00:00:00 UTC. Events with a timestamp later than this time are
     #   not exported.
     #   @return [Integer]
     #
@@ -923,9 +980,8 @@ module Aws::CloudWatchLogs
     #   Filters the results to only logs from the log streams in this list.
     #
     #   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.
+    #   `logStreamNames`, the action returns an `InvalidParameterException`
+    #   error.
     #   @return [Array<String>]
     #
     # @!attribute [rw] log_stream_name_prefix
@@ -940,13 +996,13 @@ module Aws::CloudWatchLogs
     #
     # @!attribute [rw] start_time
     #   The start of the time range, expressed as the number of milliseconds
-    #   after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this
+    #   after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this
     #   time are not returned.
     #   @return [Integer]
     #
     # @!attribute [rw] end_time
     #   The end of the time range, expressed as the number of milliseconds
-    #   after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than
+    #   after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than
     #   this time are not returned.
     #   @return [Integer]
     #
@@ -1021,7 +1077,7 @@ module Aws::CloudWatchLogs
     # Represents a matched event.
     #
     # @!attribute [rw] log_stream_name
-    #   The name of the log stream this event belongs to.
+    #   The name of the log stream to which this event belongs.
     #   @return [String]
     #
     # @!attribute [rw] timestamp
@@ -1076,14 +1132,14 @@ module Aws::CloudWatchLogs
     #
     # @!attribute [rw] start_time
     #   The start of the time range, expressed as the number of milliseconds
-    #   after Jan 1, 1970 00:00:00 UTC. Events with a time stamp equal to
-    #   this time or later than this time are included. Events with a time
-    #   stamp earlier than this time are not included.
+    #   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.
     #   @return [Integer]
     #
     # @!attribute [rw] end_time
     #   The end of the time range, expressed as the number of milliseconds
-    #   after Jan 1, 1970 00:00:00 UTC. Events with a time stamp equal to or
+    #   after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or
     #   later than this time are not included.
     #   @return [Integer]
     #
@@ -1143,6 +1199,129 @@ module Aws::CloudWatchLogs
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetLogGroupFieldsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         log_group_name: "LogGroupName", # required
+    #         time: 1,
+    #       }
+    #
+    # @!attribute [rw] log_group_name
+    #   The name of the log group to search.
+    #   @return [String]
+    #
+    # @!attribute [rw] time
+    #   The time to set as the center of the query. If you specify `time`,
+    #   the 8 minutes before and 8 minutes after this time are searched. If
+    #   you omit `time`, the past 15 minutes are queried.
+    #
+    #   The `time` value is specified as epoch time, the number of seconds
+    #   since January 1, 1970, 00:00:00 UTC.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFieldsRequest AWS API Documentation
+    #
+    class GetLogGroupFieldsRequest < Struct.new(
+      :log_group_name,
+      :time)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] log_group_fields
+    #   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.
+    #   @return [Array<Types::LogGroupField>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFieldsResponse AWS API Documentation
+    #
+    class GetLogGroupFieldsResponse < Struct.new(
+      :log_group_fields)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass GetLogRecordRequest
+    #   data as a hash:
+    #
+    #       {
+    #         log_record_pointer: "LogRecordPointer", # required
+    #       }
+    #
+    # @!attribute [rw] log_record_pointer
+    #   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.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecordRequest AWS API Documentation
+    #
+    class GetLogRecordRequest < Struct.new(
+      :log_record_pointer)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] log_record
+    #   The requested log event, as a JSON string.
+    #   @return [Hash<String,String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecordResponse AWS API Documentation
+    #
+    class GetLogRecordResponse < Struct.new(
+      :log_record)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass GetQueryResultsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         query_id: "QueryId", # required
+    #       }
+    #
+    # @!attribute [rw] query_id
+    #   The ID number of the query.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResultsRequest AWS API Documentation
+    #
+    class GetQueryResultsRequest < Struct.new(
+      :query_id)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] results
+    #   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.
+    #   @return [Array<Array<Types::ResultField>>]
+    #
+    # @!attribute [rw] statistics
+    #   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.
+    #   @return [Types::QueryStatistics]
+    #
+    # @!attribute [rw] status
+    #   The status of the most recent running of the query. Possible values
+    #   are `Cancelled`, `Complete`, `Failed`, `Running`, `Scheduled`, and
+    #   `Unknown`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResultsResponse AWS API Documentation
+    #
+    class GetQueryResultsResponse < Struct.new(
+      :results,
+      :statistics,
+      :status)
+      include Aws::Structure
+    end
+
     # Represents a log event, which is a record of activity that was
     # recorded by the application or resource being monitored.
     #
@@ -1247,6 +1426,26 @@ module Aws::CloudWatchLogs
       include Aws::Structure
     end
 
+    # The fields contained in log events found by a `GetLogGroupFields`
+    # operation, along with the percentage of queried log events in which
+    # each field appears.
+    #
+    # @!attribute [rw] name
+    #   The name of a log field.
+    #   @return [String]
+    #
+    # @!attribute [rw] percent
+    #   The percentage of log events queried that contained the field.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LogGroupField AWS API Documentation
+    #
+    class LogGroupField < Struct.new(
+      :name,
+      :percent)
+      include Aws::Structure
+    end
+
     # Represents a log stream, which is a sequence of log events from a
     # single emitter of logs.
     #
@@ -1265,11 +1464,12 @@ module Aws::CloudWatchLogs
     #   @return [Integer]
     #
     # @!attribute [rw] last_event_timestamp
-    #   the time of the most recent log event in the log stream in
+    #   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. lastEventTime updates
-    #   on an eventual consistency basis. It typically updates in less than
-    #   an hour from ingestion, but may take longer in some rare situations.
+    #   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 may take longer in some
+    #   rare situations.
     #   @return [Integer]
     #
     # @!attribute [rw] last_ingestion_time
@@ -1313,9 +1513,9 @@ module Aws::CloudWatchLogs
     #
     # @!attribute [rw] filter_pattern
     #   A symbolic description of how CloudWatch Logs should interpret the
-    #   data in each log event. For example, a log event may contain time
-    #   stamps, IP addresses, strings, and so on. You use the filter pattern
-    #   to specify what to look for in the log event message.
+    #   data in each log event. For example, a log event may contain
+    #   timestamps, IP addresses, strings, and so on. You use the filter
+    #   pattern to specify what to look for in the log event message.
     #   @return [String]
     #
     # @!attribute [rw] metric_transformations
@@ -1365,7 +1565,7 @@ module Aws::CloudWatchLogs
       include Aws::Structure
     end
 
-    # Indicates how to transform ingested log events in to metric data in a
+    # Indicates how to transform ingested log eventsto metric data in a
     # CloudWatch metric.
     #
     # @note When making an API call, you may pass MetricTransformation
@@ -1751,6 +1951,103 @@ module Aws::CloudWatchLogs
       include Aws::Structure
     end
 
+    # Reserved.
+    #
+    # @!attribute [rw] location
+    #   Reserved.
+    #   @return [Types::QueryCompileErrorLocation]
+    #
+    # @!attribute [rw] message
+    #   Reserved.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryCompileError AWS API Documentation
+    #
+    class QueryCompileError < Struct.new(
+      :location,
+      :message)
+      include Aws::Structure
+    end
+
+    # Reserved.
+    #
+    # @!attribute [rw] start_char_offset
+    #   Reserved.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end_char_offset
+    #   Reserved.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryCompileErrorLocation AWS API Documentation
+    #
+    class QueryCompileErrorLocation < Struct.new(
+      :start_char_offset,
+      :end_char_offset)
+      include Aws::Structure
+    end
+
+    # Information about one CloudWatch Logs Insights query that matches the
+    # request in a `DescribeQueries` operation.
+    #
+    # @!attribute [rw] query_id
+    #   The unique ID number of this query.
+    #   @return [String]
+    #
+    # @!attribute [rw] query_string
+    #   The query string used in this query.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of this query. Possible values are `Cancelled`,
+    #   `Complete`, `Failed`, `Running`, `Scheduled`, and `Unknown`.
+    #   @return [String]
+    #
+    # @!attribute [rw] create_time
+    #   The date and time that this query was created.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] log_group_name
+    #   The name of the log group scanned by this query.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryInfo AWS API Documentation
+    #
+    class QueryInfo < Struct.new(
+      :query_id,
+      :query_string,
+      :status,
+      :create_time,
+      :log_group_name)
+      include Aws::Structure
+    end
+
+    # 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.
+    #
+    # @!attribute [rw] records_matched
+    #   The number of log events that matched the query string.
+    #   @return [Float]
+    #
+    # @!attribute [rw] records_scanned
+    #   The total number of log events scanned during the query.
+    #   @return [Float]
+    #
+    # @!attribute [rw] bytes_scanned
+    #   The total number of bytes in the log events scanned during the
+    #   query.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryStatistics AWS API Documentation
+    #
+    class QueryStatistics < Struct.new(
+      :records_matched,
+      :records_scanned,
+      :bytes_scanned)
+      include Aws::Structure
+    end
+
     # Represents the rejected events.
     #
     # @!attribute [rw] too_new_log_event_start_index
@@ -1786,7 +2083,7 @@ module Aws::CloudWatchLogs
     #   @return [String]
     #
     # @!attribute [rw] last_updated_time
-    #   Time stamp showing when this policy was last updated, expressed as
+    #   Timestamp showing when this policy was last updated, expressed as
     #   the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
     #   @return [Integer]
     #
@@ -1799,6 +2096,25 @@ module Aws::CloudWatchLogs
       include Aws::Structure
     end
 
+    # Contains one field from one log event returned by a CloudWatch Logs
+    # Insights query, along with the value of that field.
+    #
+    # @!attribute [rw] field
+    #   The log event field.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   The value of this field.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ResultField AWS API Documentation
+    #
+    class ResultField < Struct.new(
+      :field,
+      :value)
+      include Aws::Structure
+    end
+
     # Represents the search status of a log stream.
     #
     # @!attribute [rw] log_stream_name
@@ -1817,6 +2133,99 @@ module Aws::CloudWatchLogs
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass StartQueryRequest
+    #   data as a hash:
+    #
+    #       {
+    #         log_group_name: "LogGroupName", # required
+    #         start_time: 1, # required
+    #         end_time: 1, # required
+    #         query_string: "QueryString", # required
+    #         limit: 1,
+    #       }
+    #
+    # @!attribute [rw] log_group_name
+    #   The log group on which to perform the query.
+    #   @return [String]
+    #
+    # @!attribute [rw] start_time
+    #   The time to start the query. Specified as epoch time, the number of
+    #   seconds since January 1, 1970, 00:00:00 UTC.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end_time
+    #   The time to end this query, if it is still running. Specified as
+    #   epoch time, the number of seconds since January 1, 1970, 00:00:00
+    #   UTC.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] query_string
+    #   The query string to use. For more information, see [CloudWatch Logs
+    #   Insights Query Syntax][1].
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html
+    #   @return [String]
+    #
+    # @!attribute [rw] limit
+    #   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.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartQueryRequest AWS API Documentation
+    #
+    class StartQueryRequest < Struct.new(
+      :log_group_name,
+      :start_time,
+      :end_time,
+      :query_string,
+      :limit)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] query_id
+    #   The unique ID of the query.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartQueryResponse AWS API Documentation
+    #
+    class StartQueryResponse < Struct.new(
+      :query_id)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass StopQueryRequest
+    #   data as a hash:
+    #
+    #       {
+    #         query_id: "QueryId", # required
+    #       }
+    #
+    # @!attribute [rw] query_id
+    #   The ID number of the query to stop. If necessary, you can use
+    #   `DescribeQueries` to find this ID number.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StopQueryRequest AWS API Documentation
+    #
+    class StopQueryRequest < Struct.new(
+      :query_id)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] success
+    #   This is true if the query was stopped by the `StopQuery` operation.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StopQueryResponse AWS API Documentation
+    #
+    class StopQueryResponse < Struct.new(
+      :success)
+      include Aws::Structure
+    end
+
     # Represents a subscription filter.
     #
     # @!attribute [rw] filter_name
@@ -1829,9 +2238,9 @@ module Aws::CloudWatchLogs
     #
     # @!attribute [rw] filter_pattern
     #   A symbolic description of how CloudWatch Logs should interpret the
-    #   data in each log event. For example, a log event may contain time
-    #   stamps, IP addresses, strings, and so on. You use the filter pattern
-    #   to specify what to look for in the log event message.
+    #   data in each log event. For example, a log event may contain
+    #   timestamps, IP addresses, strings, and so on. You use the filter
+    #   pattern to specify what to look for in the log event message.
     #   @return [String]
     #
     # @!attribute [rw] destination_arn
@@ -1900,9 +2309,9 @@ module Aws::CloudWatchLogs
     #
     # @!attribute [rw] filter_pattern
     #   A symbolic description of how CloudWatch Logs should interpret the
-    #   data in each log event. For example, a log event may contain time
-    #   stamps, IP addresses, strings, and so on. You use the filter pattern
-    #   to specify what to look for in the log event message.
+    #   data in each log event. For example, a log event may contain
+    #   timestamps, IP addresses, strings, and so on. You use the filter
+    #   pattern to specify what to look for in the log event message.
     #   @return [String]
     #
     # @!attribute [rw] log_event_messages