# frozen_string_literal: true
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
module Aws::CloudWatchLogs
module Types
# You don't have sufficient permissions to perform this action.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AccessDeniedException AWS API Documentation
#
class AccessDeniedException < Aws::EmptyStructure; end
# A structure that contains information about one CloudWatch Logs
# account policy.
#
# @!attribute [rw] policy_name
# The name of the account policy.
# @return [String]
#
# @!attribute [rw] policy_document
# The policy document for this account policy.
#
# The JSON specified in `policyDocument` can be up to 30,720
# characters.
# @return [String]
#
# @!attribute [rw] last_updated_time
# The date and time that this policy was most recently updated.
# @return [Integer]
#
# @!attribute [rw] policy_type
# The type of policy for this account policy.
# @return [String]
#
# @!attribute [rw] scope
# The scope of the account policy.
# @return [String]
#
# @!attribute [rw] selection_criteria
# The log group selection criteria for this subscription filter
# policy.
# @return [String]
#
# @!attribute [rw] account_id
# The Amazon Web Services account ID that the policy applies to.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AccountPolicy AWS API Documentation
#
class AccountPolicy < Struct.new(
:policy_name,
:policy_document,
:last_updated_time,
:policy_type,
:scope,
:selection_criteria,
:account_id)
SENSITIVE = []
include Aws::Structure
end
# This structure represents one anomaly that has been found by a logs
# anomaly detector.
#
# For more information about patterns and anomalies, see
# [CreateLogAnomalyDetector][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html
#
# @!attribute [rw] anomaly_id
# The unique ID that CloudWatch Logs assigned to this anomaly.
# @return [String]
#
# @!attribute [rw] pattern_id
# The ID of the pattern used to help identify this anomaly.
# @return [String]
#
# @!attribute [rw] anomaly_detector_arn
# The ARN of the anomaly detector that identified this anomaly.
# @return [String]
#
# @!attribute [rw] pattern_string
# The pattern used to help identify this anomaly, in string format.
# @return [String]
#
# @!attribute [rw] pattern_regex
# The pattern used to help identify this anomaly, in regular
# expression format.
# @return [String]
#
# @!attribute [rw] priority
# The priority level of this anomaly, as determined by CloudWatch
# Logs. Priority is computed based on log severity labels such as
# `FATAL` and `ERROR` and the amount of deviation from the baseline.
# Possible values are `HIGH`, `MEDIUM`, and `LOW`.
# @return [String]
#
# @!attribute [rw] first_seen
# The date and time when the anomaly detector first saw this anomaly.
# It is specified as epoch time, which is the number of seconds since
# `January 1, 1970, 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] last_seen
# The date and time when the anomaly detector most recently saw this
# anomaly. It is specified as epoch time, which is the number of
# seconds since `January 1, 1970, 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] description
# A human-readable description of the anomaly. This description is
# generated by CloudWatch Logs.
# @return [String]
#
# @!attribute [rw] active
# Specifies whether this anomaly is still ongoing.
# @return [Boolean]
#
# @!attribute [rw] state
# Indicates the current state of this anomaly. If it is still being
# treated as an anomaly, the value is `Active`. If you have suppressed
# this anomaly by using the [UpdateAnomaly][1] operation, the value is
# `Suppressed`. If this behavior is now considered to be normal, the
# value is `Baseline`.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html
# @return [String]
#
# @!attribute [rw] histogram
# A map showing times when the anomaly detector ran, and the number of
# occurrences of this anomaly that were detected at each of those
# runs. The times are specified in epoch time, which is the number of
# seconds since `January 1, 1970, 00:00:00 UTC`.
# @return [Hash<String,Integer>]
#
# @!attribute [rw] log_samples
# An array of sample log event messages that are considered to be part
# of this anomaly.
# @return [Array<Types::LogEvent>]
#
# @!attribute [rw] pattern_tokens
# An array of structures where each structure contains information
# about one token that makes up the pattern.
# @return [Array<Types::PatternToken>]
#
# @!attribute [rw] log_group_arn_list
# An array of ARNS of the log groups that contained log events
# considered to be part of this anomaly.
# @return [Array<String>]
#
# @!attribute [rw] suppressed
# Indicates whether this anomaly is currently suppressed. To suppress
# an anomaly, use [UpdateAnomaly][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html
# @return [Boolean]
#
# @!attribute [rw] suppressed_date
# If the anomaly is suppressed, this indicates when it was suppressed.
# @return [Integer]
#
# @!attribute [rw] suppressed_until
# If the anomaly is suppressed, this indicates when the suppression
# will end. If this value is `0`, the anomaly was suppressed with no
# expiration, with the `INFINITE` value.
# @return [Integer]
#
# @!attribute [rw] is_pattern_level_suppression
# If this anomaly is suppressed, this field is `true` if the
# suppression is because the pattern is suppressed. If `false`, then
# only this particular anomaly is suppressed.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/Anomaly AWS API Documentation
#
class Anomaly < Struct.new(
:anomaly_id,
:pattern_id,
:anomaly_detector_arn,
:pattern_string,
:pattern_regex,
:priority,
:first_seen,
:last_seen,
:description,
:active,
:state,
:histogram,
:log_samples,
:pattern_tokens,
:log_group_arn_list,
:suppressed,
:suppressed_date,
:suppressed_until,
:is_pattern_level_suppression)
SENSITIVE = []
include Aws::Structure
end
# Contains information about one anomaly detector in the account.
#
# @!attribute [rw] anomaly_detector_arn
# The ARN of the anomaly detector.
# @return [String]
#
# @!attribute [rw] detector_name
# The name of the anomaly detector.
# @return [String]
#
# @!attribute [rw] log_group_arn_list
# A list of the ARNs of the log groups that this anomaly detector
# watches.
# @return [Array<String>]
#
# @!attribute [rw] evaluation_frequency
# Specifies how often the anomaly detector runs and look for
# anomalies.
# @return [String]
#
# @!attribute [rw] filter_pattern
# 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.
# @return [String]
#
# @!attribute [rw] anomaly_detector_status
# Specifies the current status of the anomaly detector. To pause an
# anomaly detector, use the `enabled` parameter in the
# [UpdateLogAnomalyDetector][1] operation.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html
# @return [String]
#
# @!attribute [rw] kms_key_id
# The ID of the KMS key assigned to this anomaly detector, if any.
# @return [String]
#
# @!attribute [rw] creation_time_stamp
# The date and time when this anomaly detector was created.
# @return [Integer]
#
# @!attribute [rw] last_modified_time_stamp
# The date and time when this anomaly detector was most recently
# modified.
# @return [Integer]
#
# @!attribute [rw] anomaly_visibility_time
# The number of days used as the life cycle of anomalies. After this
# time, anomalies are automatically baselined and the anomaly detector
# model will treat new occurrences of similar event as normal.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AnomalyDetector AWS API Documentation
#
class AnomalyDetector < Struct.new(
:anomaly_detector_arn,
:detector_name,
:log_group_arn_list,
:evaluation_frequency,
:filter_pattern,
:anomaly_detector_status,
:kms_key_id,
:creation_time_stamp,
:last_modified_time_stamp,
:anomaly_visibility_time)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
#
# In your `AssociateKmsKey` operation, you must specify either the
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
# can't specify both.
# @return [String]
#
# @!attribute [rw] kms_key_id
# The Amazon Resource Name (ARN) of the KMS key to use when encrypting
# log data. This must be a symmetric KMS key. For more information,
# see [Amazon Resource Names][1] and [Using Symmetric and Asymmetric
# Keys][2].
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
# @return [String]
#
# @!attribute [rw] resource_identifier
# Specifies the target for this operation. You must specify one of the
# following:
#
# * Specify the following ARN to have future [GetQueryResults][1]
# operations in this account encrypt the results with the specified
# KMS key. Replace *REGION* and *ACCOUNT\_ID* with your Region and
# account ID.
#
# `arn:aws:logs:REGION:ACCOUNT_ID:query-result:*`
#
# * Specify the ARN of a log group to have CloudWatch Logs use the KMS
# key to encrypt log events that are ingested and stored by that log
# group. The log group ARN must be in the following format. Replace
# *REGION* and *ACCOUNT\_ID* with your Region and account ID.
#
# `arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME `
#
# In your `AssociateKmsKey` operation, you must specify either the
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
# can't specify both.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateKmsKeyRequest AWS API Documentation
#
class AssociateKmsKeyRequest < Struct.new(
:log_group_name,
:kms_key_id,
:resource_identifier)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] task_id
# The ID of the export task.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CancelExportTaskRequest AWS API Documentation
#
class CancelExportTaskRequest < Struct.new(
:task_id)
SENSITIVE = []
include Aws::Structure
end
# This operation attempted to create a resource that already exists.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ConflictException AWS API Documentation
#
class ConflictException < Aws::EmptyStructure; end
# @!attribute [rw] delivery_source_name
# The name of the delivery source to use for this delivery.
# @return [String]
#
# @!attribute [rw] delivery_destination_arn
# The ARN of the delivery destination to use for this delivery.
# @return [String]
#
# @!attribute [rw] tags
# An optional list of key-value pairs to associate with the resource.
#
# For more information about tagging, see [Tagging Amazon Web Services
# resources][1]
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateDeliveryRequest AWS API Documentation
#
class CreateDeliveryRequest < Struct.new(
:delivery_source_name,
:delivery_destination_arn,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery
# A structure that contains information about the delivery that you
# just created.
# @return [Types::Delivery]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateDeliveryResponse AWS API Documentation
#
class CreateDeliveryResponse < Struct.new(
:delivery)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] task_name
# The name of the export task.
# @return [String]
#
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] log_stream_name_prefix
# Export only log streams that match the provided prefix. If you
# don't specify a value, no prefix filter is applied.
# @return [String]
#
# @!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
# 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
# timestamp later than this time are not exported.
#
# You must specify a time that is not earlier than when this log group
# was created.
# @return [Integer]
#
# @!attribute [rw] destination
# The name of S3 bucket for the exported log data. The bucket must be
# in the same Amazon Web Services Region.
# @return [String]
#
# @!attribute [rw] destination_prefix
# The prefix used as the start of the key for every object exported.
# If you don't specify a value, the default is `exportedlogs`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateExportTaskRequest AWS API Documentation
#
class CreateExportTaskRequest < Struct.new(
:task_name,
:log_group_name,
:log_stream_name_prefix,
:from,
:to,
:destination,
:destination_prefix)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] task_id
# The ID of the export task.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateExportTaskResponse AWS API Documentation
#
class CreateExportTaskResponse < Struct.new(
:task_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_arn_list
# An array containing the ARN of the log group that this anomaly
# detector will watch. You can specify only one log group ARN.
# @return [Array<String>]
#
# @!attribute [rw] detector_name
# A name for this anomaly detector.
# @return [String]
#
# @!attribute [rw] evaluation_frequency
# Specifies how often the anomaly detector is to run and look for
# anomalies. Set this value according to the frequency that the log
# group receives new logs. For example, if the log group receives new
# log events every 10 minutes, then 15 minutes might be a good setting
# for `evaluationFrequency` .
# @return [String]
#
# @!attribute [rw] filter_pattern
# You can use this parameter to limit the anomaly detection model to
# examine only log events that match the pattern you specify here. For
# more information, see [Filter and Pattern Syntax][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html
# @return [String]
#
# @!attribute [rw] kms_key_id
# Optionally assigns a KMS key to secure this anomaly detector and its
# findings. If a key is assigned, the anomalies found and the model
# used by this detector are encrypted at rest with the key. If a key
# is assigned to an anomaly detector, a user must have permissions for
# both this key and for the anomaly detector to retrieve information
# about the anomalies that it finds.
#
# For more information about using a KMS key and to see the required
# IAM policy, see [Use a KMS key with an anomaly detector][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection-KMS.html
# @return [String]
#
# @!attribute [rw] anomaly_visibility_time
# The number of days to have visibility on an anomaly. After this time
# period has elapsed for an anomaly, it will be automatically
# baselined and the anomaly detector will treat new occurrences of a
# similar anomaly as normal. Therefore, if you do not correct the
# cause of an anomaly during the time period specified in
# `anomalyVisibilityTime`, it will be considered normal going forward
# and will not be detected as an anomaly.
# @return [Integer]
#
# @!attribute [rw] tags
# An optional list of key-value pairs to associate with the resource.
#
# For more information about tagging, see [Tagging Amazon Web Services
# resources][1]
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogAnomalyDetectorRequest AWS API Documentation
#
class CreateLogAnomalyDetectorRequest < Struct.new(
:log_group_arn_list,
:detector_name,
:evaluation_frequency,
:filter_pattern,
:kms_key_id,
:anomaly_visibility_time,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] anomaly_detector_arn
# The ARN of the log anomaly detector that you just created.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogAnomalyDetectorResponse AWS API Documentation
#
class CreateLogAnomalyDetectorResponse < Struct.new(
:anomaly_detector_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# A name for the log group.
# @return [String]
#
# @!attribute [rw] kms_key_id
# The Amazon Resource Name (ARN) of the KMS key to use when encrypting
# log data. For more information, see [Amazon Resource Names][1].
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
# @return [String]
#
# @!attribute [rw] tags
# The key-value pairs to use for the tags.
#
# You can grant users access to certain log groups while preventing
# them from accessing other log groups. To do so, tag your groups and
# use IAM policies that refer to those tags. To assign tags when you
# create a log group, you must have either the `logs:TagResource` or
# `logs:TagLogGroup` permission. For more information about tagging,
# see [Tagging Amazon Web Services resources][1]. For more information
# about using tags to control access, see [Controlling access to
# Amazon Web Services resources using tags][2].
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html
# @return [Hash<String,String>]
#
# @!attribute [rw] log_group_class
# Use this parameter to specify the log group class for this log
# group. There are two classes:
#
# * The `Standard` log class supports all CloudWatch Logs features.
#
# * The `Infrequent Access` log class supports a subset of CloudWatch
# Logs features and incurs lower costs.
#
# If you omit this parameter, the default of `STANDARD` is used.
#
# The value of `logGroupClass` can't be changed after a log group is
# created.
#
# For details about the features supported by each class, see [Log
# classes][1]
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogGroupRequest AWS API Documentation
#
class CreateLogGroupRequest < Struct.new(
:log_group_name,
:kms_key_id,
:tags,
:log_group_class)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] log_stream_name
# The name of the log stream.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateLogStreamRequest AWS API Documentation
#
class CreateLogStreamRequest < Struct.new(
:log_group_name,
:log_stream_name)
SENSITIVE = []
include Aws::Structure
end
# The event was already logged.
#
# `PutLogEvents` actions are now always accepted and never return
# `DataAlreadyAcceptedException` regardless of whether a given batch of
# log events has already been accepted.
#
# @!attribute [rw] expected_sequence_token
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DataAlreadyAcceptedException AWS API Documentation
#
class DataAlreadyAcceptedException < Struct.new(
:expected_sequence_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] policy_name
# The name of the policy to delete.
# @return [String]
#
# @!attribute [rw] policy_type
# The type of policy to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteAccountPolicyRequest AWS API Documentation
#
class DeleteAccountPolicyRequest < Struct.new(
:policy_name,
:policy_type)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_identifier
# The name or ARN of the log group that you want to delete the data
# protection policy for.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDataProtectionPolicyRequest AWS API Documentation
#
class DeleteDataProtectionPolicyRequest < Struct.new(
:log_group_identifier)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery_destination_name
# The name of the delivery destination that you want to delete the
# policy for.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliveryDestinationPolicyRequest AWS API Documentation
#
class DeleteDeliveryDestinationPolicyRequest < Struct.new(
:delivery_destination_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] name
# The name of the delivery destination that you want to delete. You
# can find a list of delivery destionation names by using the
# [DescribeDeliveryDestinations][1] operation.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveryDestinations.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliveryDestinationRequest AWS API Documentation
#
class DeleteDeliveryDestinationRequest < Struct.new(
:name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] id
# The unique ID of the delivery to delete. You can find the ID of a
# delivery with the [DescribeDeliveries][1] operation.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliveryRequest AWS API Documentation
#
class DeleteDeliveryRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] name
# The name of the delivery source that you want to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDeliverySourceRequest AWS API Documentation
#
class DeleteDeliverySourceRequest < Struct.new(
:name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] destination_name
# The name of the destination.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDestinationRequest AWS API Documentation
#
class DeleteDestinationRequest < Struct.new(
:destination_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] anomaly_detector_arn
# The ARN of the anomaly detector to delete. You can find the ARNs of
# log anomaly detectors in your account by using the
# [ListLogAnomalyDetectors][1] operation.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogAnomalyDetectorRequest AWS API Documentation
#
class DeleteLogAnomalyDetectorRequest < Struct.new(
:anomaly_detector_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogGroupRequest AWS API Documentation
#
class DeleteLogGroupRequest < Struct.new(
:log_group_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] log_stream_name
# The name of the log stream.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteLogStreamRequest AWS API Documentation
#
class DeleteLogStreamRequest < Struct.new(
:log_group_name,
:log_stream_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] filter_name
# The name of the metric filter.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteMetricFilterRequest AWS API Documentation
#
class DeleteMetricFilterRequest < Struct.new(
:log_group_name,
:filter_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] query_definition_id
# The ID of the query definition that you want to delete. You can use
# [DescribeQueryDefinitions][1] to retrieve the IDs of your saved
# query definitions.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteQueryDefinitionRequest AWS API Documentation
#
class DeleteQueryDefinitionRequest < Struct.new(
:query_definition_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] success
# A value of TRUE indicates that the operation succeeded. FALSE
# indicates that the operation failed.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteQueryDefinitionResponse AWS API Documentation
#
class DeleteQueryDefinitionResponse < Struct.new(
:success)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] policy_name
# The name of the policy to be revoked. This parameter is required.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteResourcePolicyRequest AWS API Documentation
#
class DeleteResourcePolicyRequest < Struct.new(
:policy_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteRetentionPolicyRequest AWS API Documentation
#
class DeleteRetentionPolicyRequest < Struct.new(
:log_group_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] filter_name
# The name of the subscription filter.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteSubscriptionFilterRequest AWS API Documentation
#
class DeleteSubscriptionFilterRequest < Struct.new(
:log_group_name,
:filter_name)
SENSITIVE = []
include Aws::Structure
end
# This structure contains information about one *delivery* in your
# account.
#
# A delivery is a connection between a logical *delivery source* and a
# logical *delivery destination*.
#
# For more information, see [CreateDelivery][1].
#
# You can't update an existing delivery. You can only create and delete
# deliveries.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html
#
# @!attribute [rw] id
# The unique ID that identifies this delivery in your account.
# @return [String]
#
# @!attribute [rw] arn
# The Amazon Resource Name (ARN) that uniquely identifies this
# delivery.
# @return [String]
#
# @!attribute [rw] delivery_source_name
# The name of the delivery source that is associated with this
# delivery.
# @return [String]
#
# @!attribute [rw] delivery_destination_arn
# The ARN of the delivery destination that is associated with this
# delivery.
# @return [String]
#
# @!attribute [rw] delivery_destination_type
# Displays whether the delivery destination associated with this
# delivery is CloudWatch Logs, Amazon S3, or Firehose.
# @return [String]
#
# @!attribute [rw] tags
# The tags that have been assigned to this delivery.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/Delivery AWS API Documentation
#
class Delivery < Struct.new(
:id,
:arn,
:delivery_source_name,
:delivery_destination_arn,
:delivery_destination_type,
:tags)
SENSITIVE = []
include Aws::Structure
end
# This structure contains information about one *delivery destination*
# in your account. A delivery destination is an Amazon Web Services
# resource that represents an Amazon Web Services service that logs can
# be sent to. CloudWatch Logs, Amazon S3, are supported as Firehose
# delivery destinations.
#
# To configure logs delivery between a supported Amazon Web Services
# service and a destination, you must do the following:
#
# * Create a delivery source, which is a logical object that represents
# the resource that is actually sending the logs. For more
# information, see [PutDeliverySource][1].
#
# * Create a *delivery destination*, which is a logical object that
# represents the actual delivery destination.
#
# * If you are delivering logs cross-account, you must use
# [PutDeliveryDestinationPolicy][2] in the destination account to
# assign an IAM policy to the destination. This policy allows delivery
# to that destination.
#
# * Create a *delivery* by pairing exactly one delivery source and one
# delivery destination. For more information, see [CreateDelivery][3].
#
# You can configure a single delivery source to send logs to multiple
# destinations by creating multiple deliveries. You can also create
# multiple deliveries to configure multiple delivery sources to send
# logs to the same delivery destination.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html
# [3]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html
#
# @!attribute [rw] name
# The name of this delivery destination.
# @return [String]
#
# @!attribute [rw] arn
# The Amazon Resource Name (ARN) that uniquely identifies this
# delivery destination.
# @return [String]
#
# @!attribute [rw] delivery_destination_type
# Displays whether this delivery destination is CloudWatch Logs,
# Amazon S3, or Firehose.
# @return [String]
#
# @!attribute [rw] output_format
# The format of the logs that are sent to this delivery destination.
# @return [String]
#
# @!attribute [rw] delivery_destination_configuration
# A structure that contains the ARN of the Amazon Web Services
# resource that will receive the logs.
# @return [Types::DeliveryDestinationConfiguration]
#
# @!attribute [rw] tags
# The tags that have been assigned to this delivery destination.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeliveryDestination AWS API Documentation
#
class DeliveryDestination < Struct.new(
:name,
:arn,
:delivery_destination_type,
:output_format,
:delivery_destination_configuration,
:tags)
SENSITIVE = []
include Aws::Structure
end
# A structure that contains information about one logs delivery
# destination.
#
# @!attribute [rw] destination_resource_arn
# The ARN of the Amazon Web Services destination that this delivery
# destination represents. That Amazon Web Services destination can be
# a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery
# stream in Firehose.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeliveryDestinationConfiguration AWS API Documentation
#
class DeliveryDestinationConfiguration < Struct.new(
:destination_resource_arn)
SENSITIVE = []
include Aws::Structure
end
# This structure contains information about one *delivery source* in
# your account. A delivery source is an Amazon Web Services resource
# that sends logs to an Amazon Web Services destination. The destination
# can be CloudWatch Logs, Amazon S3, or Firehose.
#
# Only some Amazon Web Services services support being configured as a
# delivery source. These services are listed as **Supported \[V2
# Permissions\]** in the table at [Enabling logging from Amazon Web
# Services services.][1]
#
# To configure logs delivery between a supported Amazon Web Services
# service and a destination, you must do the following:
#
# * Create a delivery source, which is a logical object that represents
# the resource that is actually sending the logs. For more
# information, see [PutDeliverySource][2].
#
# * Create a *delivery destination*, which is a logical object that
# represents the actual delivery destination. For more information,
# see [PutDeliveryDestination][3].
#
# * If you are delivering logs cross-account, you must use
# [PutDeliveryDestinationPolicy][4] in the destination account to
# assign an IAM policy to the destination. This policy allows delivery
# to that destination.
#
# * Create a *delivery* by pairing exactly one delivery source and one
# delivery destination. For more information, see [CreateDelivery][5].
#
# You can configure a single delivery source to send logs to multiple
# destinations by creating multiple deliveries. You can also create
# multiple deliveries to configure multiple delivery sources to send
# logs to the same delivery destination.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html
# [3]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html
# [4]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html
# [5]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html
#
# @!attribute [rw] name
# The unique name of the delivery source.
# @return [String]
#
# @!attribute [rw] arn
# The Amazon Resource Name (ARN) that uniquely identifies this
# delivery source.
# @return [String]
#
# @!attribute [rw] resource_arns
# This array contains the ARN of the Amazon Web Services resource that
# sends logs and is represented by this delivery source. Currently,
# only one ARN can be in the array.
# @return [Array<String>]
#
# @!attribute [rw] service
# The Amazon Web Services service that is sending logs.
# @return [String]
#
# @!attribute [rw] log_type
# The type of log that the source is sending. For valid values for
# this parameter, see the documentation for the source service.
# @return [String]
#
# @!attribute [rw] tags
# The tags that have been assigned to this delivery source.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeliverySource AWS API Documentation
#
class DeliverySource < Struct.new(
:name,
:arn,
:resource_arns,
:service,
:log_type,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] policy_type
# Use this parameter to limit the returned policies to only the
# policies that match the policy type that you specify.
# @return [String]
#
# @!attribute [rw] policy_name
# Use this parameter to limit the returned policies to only the policy
# with the name that you specify.
# @return [String]
#
# @!attribute [rw] account_identifiers
# If you are using an account that is set up as a monitoring account
# for CloudWatch unified cross-account observability, you can use this
# to specify the account ID of a source account. If you do, the
# operation returns the account policy for the specified account.
# Currently, you can specify only one account ID in this parameter.
#
# If you omit this parameter, only the policy in the current account
# is returned.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeAccountPoliciesRequest AWS API Documentation
#
class DescribeAccountPoliciesRequest < Struct.new(
:policy_type,
:policy_name,
:account_identifiers)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] account_policies
# An array of structures that contain information about the CloudWatch
# Logs account policies that match the specified filters.
# @return [Array<Types::AccountPolicy>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeAccountPoliciesResponse AWS API Documentation
#
class DescribeAccountPoliciesResponse < Struct.new(
:account_policies)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] next_token
# The token for the next set of items to return. The token expires
# after 24 hours.
# @return [String]
#
# @!attribute [rw] limit
# Optionally specify the maximum number of deliveries to return in the
# response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDeliveriesRequest AWS API Documentation
#
class DescribeDeliveriesRequest < Struct.new(
:next_token,
:limit)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] deliveries
# An array of structures. Each structure contains information about
# one delivery in the account.
# @return [Array<Types::Delivery>]
#
# @!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/DescribeDeliveriesResponse AWS API Documentation
#
class DescribeDeliveriesResponse < Struct.new(
:deliveries,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] next_token
# The token for the next set of items to return. The token expires
# after 24 hours.
# @return [String]
#
# @!attribute [rw] limit
# Optionally specify the maximum number of delivery destinations to
# return in the response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDeliveryDestinationsRequest AWS API Documentation
#
class DescribeDeliveryDestinationsRequest < Struct.new(
:next_token,
:limit)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery_destinations
# An array of structures. Each structure contains information about
# one delivery destination in the account.
# @return [Array<Types::DeliveryDestination>]
#
# @!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/DescribeDeliveryDestinationsResponse AWS API Documentation
#
class DescribeDeliveryDestinationsResponse < Struct.new(
:delivery_destinations,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] next_token
# The token for the next set of items to return. The token expires
# after 24 hours.
# @return [String]
#
# @!attribute [rw] limit
# Optionally specify the maximum number of delivery sources to return
# in the response.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDeliverySourcesRequest AWS API Documentation
#
class DescribeDeliverySourcesRequest < Struct.new(
:next_token,
:limit)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery_sources
# An array of structures. Each structure contains information about
# one delivery source in the account.
# @return [Array<Types::DeliverySource>]
#
# @!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/DescribeDeliverySourcesResponse AWS API Documentation
#
class DescribeDeliverySourcesResponse < Struct.new(
:delivery_sources,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] destination_name_prefix
# The prefix to match. If you don't specify a value, no prefix filter
# is applied.
# @return [String]
#
# @!attribute [rw] next_token
# The token for the next set of items to return. (You received this
# token from a previous call.)
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of items returned. If you don't specify a value,
# the default maximum value of 50 items is used.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDestinationsRequest AWS API Documentation
#
class DescribeDestinationsRequest < Struct.new(
:destination_name_prefix,
:next_token,
:limit)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] destinations
# The destinations.
# @return [Array<Types::Destination>]
#
# @!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/DescribeDestinationsResponse AWS API Documentation
#
class DescribeDestinationsResponse < Struct.new(
:destinations,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] task_id
# The ID of the export task. Specifying a task ID filters the results
# to one or zero export tasks.
# @return [String]
#
# @!attribute [rw] status_code
# The status code of the export task. Specifying a status code filters
# the results to zero or more export tasks.
# @return [String]
#
# @!attribute [rw] next_token
# The token for the next set of items to return. (You received this
# token from a previous call.)
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of items returned. If you don't specify a value,
# the default is up to 50 items.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeExportTasksRequest AWS API Documentation
#
class DescribeExportTasksRequest < Struct.new(
:task_id,
:status_code,
:next_token,
:limit)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] export_tasks
# The export tasks.
# @return [Array<Types::ExportTask>]
#
# @!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/DescribeExportTasksResponse AWS API Documentation
#
class DescribeExportTasksResponse < Struct.new(
:export_tasks,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] account_identifiers
# When `includeLinkedAccounts` is set to `True`, use this parameter to
# specify the list of accounts to search. You can specify as many as
# 20 account IDs in the array.
# @return [Array<String>]
#
# @!attribute [rw] log_group_name_prefix
# The prefix to match.
#
# <note markdown="1"> `logGroupNamePrefix` and `logGroupNamePattern` are mutually
# exclusive. Only one of these parameters can be passed.
#
# </note>
# @return [String]
#
# @!attribute [rw] log_group_name_pattern
# If you specify a string for this parameter, the operation returns
# only log groups that have names that match the string based on a
# case-sensitive substring search. For example, if you specify `Foo`,
# log groups named `FooBar`, `aws/Foo`, and `GroupFoo` would match,
# but `foo`, `F/o/o` and `Froo` would not match.
#
# If you specify `logGroupNamePattern` in your request, then only
# `arn`, `creationTime`, and `logGroupName` are included in the
# response.
#
# <note markdown="1"> `logGroupNamePattern` and `logGroupNamePrefix` are mutually
# exclusive. Only one of these parameters can be passed.
#
# </note>
# @return [String]
#
# @!attribute [rw] next_token
# The token for the next set of items to return. (You received this
# token from a previous call.)
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of items returned. If you don't specify a value,
# the default is up to 50 items.
# @return [Integer]
#
# @!attribute [rw] include_linked_accounts
# If you are using a monitoring account, set this to `True` to have
# the operation return log groups in the accounts listed in
# `accountIdentifiers`.
#
# If this parameter is set to `true` and `accountIdentifiers` contains
# a null value, the operation returns all log groups in the monitoring
# account and all log groups in all source accounts that are linked to
# the monitoring account.
# @return [Boolean]
#
# @!attribute [rw] log_group_class
# Specifies the log group class for this log group. There are two
# classes:
#
# * The `Standard` log class supports all CloudWatch Logs features.
#
# * The `Infrequent Access` log class supports a subset of CloudWatch
# Logs features and incurs lower costs.
#
# For details about the features supported by each class, see [Log
# classes][1]
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogGroupsRequest AWS API Documentation
#
class DescribeLogGroupsRequest < Struct.new(
:account_identifiers,
:log_group_name_prefix,
:log_group_name_pattern,
:next_token,
:limit,
:include_linked_accounts,
:log_group_class)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_groups
# The log groups.
#
# If the `retentionInDays` value is not included for a log group, then
# that log group's events do not expire.
# @return [Array<Types::LogGroup>]
#
# @!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/DescribeLogGroupsResponse AWS API Documentation
#
class DescribeLogGroupsResponse < Struct.new(
:log_groups,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
#
# <note markdown="1"> You must include either `logGroupIdentifier` or `logGroupName`, but
# not both.
#
# </note>
# @return [String]
#
# @!attribute [rw] log_group_identifier
# Specify either the name or ARN of the log group to view. If the log
# group is in a source account and you are using a monitoring account,
# you must use the log group ARN.
#
# <note markdown="1"> You must include either `logGroupIdentifier` or `logGroupName`, but
# not both.
#
# </note>
# @return [String]
#
# @!attribute [rw] log_stream_name_prefix
# The prefix to match.
#
# If `orderBy` is `LastEventTime`, you cannot specify this parameter.
# @return [String]
#
# @!attribute [rw] order_by
# 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.
# @return [String]
#
# @!attribute [rw] descending
# 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.
# @return [Boolean]
#
# @!attribute [rw] next_token
# The token for the next set of items to return. (You received this
# token from a previous call.)
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of items returned. If you don't specify a value,
# the default is up to 50 items.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogStreamsRequest AWS API Documentation
#
class DescribeLogStreamsRequest < Struct.new(
:log_group_name,
:log_group_identifier,
:log_stream_name_prefix,
:order_by,
:descending,
:next_token,
:limit)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_streams
# The log streams.
# @return [Array<Types::LogStream>]
#
# @!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/DescribeLogStreamsResponse AWS API Documentation
#
class DescribeLogStreamsResponse < Struct.new(
:log_streams,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] filter_name_prefix
# The prefix to match. CloudWatch Logs uses the value that you set
# here only if you also include the `logGroupName` parameter in your
# request.
# @return [String]
#
# @!attribute [rw] next_token
# The token for the next set of items to return. (You received this
# token from a previous call.)
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of items returned. If you don't specify a value,
# the default is up to 50 items.
# @return [Integer]
#
# @!attribute [rw] metric_name
# 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.
# @return [String]
#
# @!attribute [rw] metric_namespace
# 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeMetricFiltersRequest AWS API Documentation
#
class DescribeMetricFiltersRequest < Struct.new(
:log_group_name,
:filter_name_prefix,
:next_token,
:limit,
:metric_name,
:metric_namespace)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] metric_filters
# The metric filters.
# @return [Array<Types::MetricFilter>]
#
# @!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/DescribeMetricFiltersResponse AWS API Documentation
#
class DescribeMetricFiltersResponse < Struct.new(
:metric_filters,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!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)
SENSITIVE = []
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)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] query_definition_name_prefix
# Use this parameter to filter your results to only the query
# definitions that have names that start with the prefix you specify.
# @return [String]
#
# @!attribute [rw] max_results
# Limits the number of returned query definitions 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/DescribeQueryDefinitionsRequest AWS API Documentation
#
class DescribeQueryDefinitionsRequest < Struct.new(
:query_definition_name_prefix,
:max_results,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] query_definitions
# The list of query definitions that match your request.
# @return [Array<Types::QueryDefinition>]
#
# @!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/DescribeQueryDefinitionsResponse AWS API Documentation
#
class DescribeQueryDefinitionsResponse < Struct.new(
:query_definitions,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] next_token
# The token for the next set of items to return. The token expires
# after 24 hours.
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of resource policies to be displayed with one
# call of this API.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeResourcePoliciesRequest AWS API Documentation
#
class DescribeResourcePoliciesRequest < Struct.new(
:next_token,
:limit)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] resource_policies
# The resource policies that exist in this account.
# @return [Array<Types::ResourcePolicy>]
#
# @!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/DescribeResourcePoliciesResponse AWS API Documentation
#
class DescribeResourcePoliciesResponse < Struct.new(
:resource_policies,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] filter_name_prefix
# The prefix to match. If you don't specify a value, no prefix filter
# is applied.
# @return [String]
#
# @!attribute [rw] next_token
# The token for the next set of items to return. (You received this
# token from a previous call.)
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of items returned. If you don't specify a value,
# the default is up to 50 items.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeSubscriptionFiltersRequest AWS API Documentation
#
class DescribeSubscriptionFiltersRequest < Struct.new(
:log_group_name,
:filter_name_prefix,
:next_token,
:limit)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] subscription_filters
# The subscription filters.
# @return [Array<Types::SubscriptionFilter>]
#
# @!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/DescribeSubscriptionFiltersResponse AWS API Documentation
#
class DescribeSubscriptionFiltersResponse < Struct.new(
:subscription_filters,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# Represents a cross-account destination that receives subscription log
# events.
#
# @!attribute [rw] destination_name
# The name of the destination.
# @return [String]
#
# @!attribute [rw] target_arn
# The Amazon Resource Name (ARN) of the physical target where the log
# events are delivered (for example, a Kinesis stream).
# @return [String]
#
# @!attribute [rw] role_arn
# A role for impersonation, used when delivering log events to the
# target.
# @return [String]
#
# @!attribute [rw] access_policy
# An IAM policy document that governs which Amazon Web Services
# accounts can create subscription filters against this destination.
# @return [String]
#
# @!attribute [rw] arn
# The ARN of this destination.
# @return [String]
#
# @!attribute [rw] creation_time
# The creation time of the destination, expressed as the number of
# milliseconds after Jan 1, 1970 00:00:00 UTC.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/Destination AWS API Documentation
#
class Destination < Struct.new(
:destination_name,
:target_arn,
:role_arn,
:access_policy,
:arn,
:creation_time)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
#
# In your `DisassociateKmsKey` operation, you must specify either the
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
# can't specify both.
# @return [String]
#
# @!attribute [rw] resource_identifier
# Specifies the target for this operation. You must specify one of the
# following:
#
# * Specify the ARN of a log group to stop having CloudWatch Logs use
# the KMS key to encrypt log events that are ingested and stored by
# that log group. After you run this operation, CloudWatch Logs
# encrypts ingested log events with the default CloudWatch Logs
# method. The log group ARN must be in the following format. Replace
# *REGION* and *ACCOUNT\_ID* with your Region and account ID.
#
# `arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME `
#
# * Specify the following ARN to stop using this key to encrypt the
# results of future [StartQuery][1] operations in this account.
# Replace *REGION* and *ACCOUNT\_ID* with your Region and account
# ID.
#
# `arn:aws:logs:REGION:ACCOUNT_ID:query-result:*`
#
# In your `DisssociateKmsKey` operation, you must specify either the
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
# can't specify both.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateKmsKeyRequest AWS API Documentation
#
class DisassociateKmsKeyRequest < Struct.new(
:log_group_name,
:resource_identifier)
SENSITIVE = []
include Aws::Structure
end
# Represents an export task.
#
# @!attribute [rw] task_id
# The ID of the export task.
# @return [String]
#
# @!attribute [rw] task_name
# The name of the export task.
# @return [String]
#
# @!attribute [rw] log_group_name
# The name of the log group from which logs data was exported.
# @return [String]
#
# @!attribute [rw] from
# 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.
# @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 timestamp later than this time are
# not exported.
# @return [Integer]
#
# @!attribute [rw] destination
# The name of the S3 bucket to which the log data was exported.
# @return [String]
#
# @!attribute [rw] destination_prefix
# The prefix that was used as the start of Amazon S3 key for every
# object exported.
# @return [String]
#
# @!attribute [rw] status
# The status of the export task.
# @return [Types::ExportTaskStatus]
#
# @!attribute [rw] execution_info
# Execution information about the export task.
# @return [Types::ExportTaskExecutionInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ExportTask AWS API Documentation
#
class ExportTask < Struct.new(
:task_id,
:task_name,
:log_group_name,
:from,
:to,
:destination,
:destination_prefix,
:status,
:execution_info)
SENSITIVE = []
include Aws::Structure
end
# Represents the status of an export task.
#
# @!attribute [rw] creation_time
# The creation time of the export task, expressed as the number of
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] completion_time
# The completion time of the export task, expressed as the number of
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ExportTaskExecutionInfo AWS API Documentation
#
class ExportTaskExecutionInfo < Struct.new(
:creation_time,
:completion_time)
SENSITIVE = []
include Aws::Structure
end
# Represents the status of an export task.
#
# @!attribute [rw] code
# The status code of the export task.
# @return [String]
#
# @!attribute [rw] message
# The status message related to the status code.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ExportTaskStatus AWS API Documentation
#
class ExportTaskStatus < Struct.new(
:code,
:message)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group to search.
#
# <note markdown="1"> You must include either `logGroupIdentifier` or `logGroupName`, but
# not both.
#
# </note>
# @return [String]
#
# @!attribute [rw] log_group_identifier
# Specify either the name or ARN of the log group to view log events
# from. If the log group is in a source account and you are using a
# monitoring account, you must use the log group ARN.
#
# <note markdown="1"> You must include either `logGroupIdentifier` or `logGroupName`, but
# not both.
#
# </note>
# @return [String]
#
# @!attribute [rw] log_stream_names
# 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.
# @return [Array<String>]
#
# @!attribute [rw] log_stream_name_prefix
# 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.
# @return [String]
#
# @!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 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 timestamp later than
# this time are not returned.
# @return [Integer]
#
# @!attribute [rw] filter_pattern
# The filter pattern to use. For more information, see [Filter and
# Pattern Syntax][1].
#
# If not provided, all the events are matched.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html
# @return [String]
#
# @!attribute [rw] next_token
# The token for the next set of events to return. (You received this
# token from a previous call.)
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of events to return. The default is 10,000
# events.
# @return [Integer]
#
# @!attribute [rw] interleaved
# If the value is true, the operation attempts to provide responses
# that contain events from multiple log streams within the log group,
# interleaved in a single response. If the value is false, all the
# matched log events in the first log stream are searched first, then
# those in the next log stream, and so on.
#
# **Important** As of June 17, 2019, this parameter is ignored and the
# value is assumed to be true. The response from this operation always
# interleaves events from multiple log streams within a log group.
# @return [Boolean]
#
# @!attribute [rw] unmask
# Specify `true` to display the log event fields with all sensitive
# data unmasked and visible. The default is `false`.
#
# To use this operation with this parameter, you must be signed into
# an account with the `logs:Unmask` permission.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilterLogEventsRequest AWS API Documentation
#
class FilterLogEventsRequest < Struct.new(
:log_group_name,
:log_group_identifier,
:log_stream_names,
:log_stream_name_prefix,
:start_time,
:end_time,
:filter_pattern,
:next_token,
:limit,
:interleaved,
:unmask)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] events
# The matched events.
# @return [Array<Types::FilteredLogEvent>]
#
# @!attribute [rw] searched_log_streams
# **Important** As of May 15, 2020, this parameter is no longer
# supported. This parameter returns an empty list.
#
# Indicates which log streams have been searched and whether each has
# been searched completely.
# @return [Array<Types::SearchedLogStream>]
#
# @!attribute [rw] next_token
# The token to use when requesting the next set of items. The token
# expires after 24 hours.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilterLogEventsResponse AWS API Documentation
#
class FilterLogEventsResponse < Struct.new(
:events,
:searched_log_streams,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# Represents a matched event.
#
# @!attribute [rw] log_stream_name
# The name of the log stream to which this event belongs.
# @return [String]
#
# @!attribute [rw] timestamp
# The time the event occurred, expressed as the number of milliseconds
# after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] message
# The data contained in the log event.
# @return [String]
#
# @!attribute [rw] ingestion_time
# The time the event was ingested, expressed as the number of
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] event_id
# The ID of the event.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilteredLogEvent AWS API Documentation
#
class FilteredLogEvent < Struct.new(
:log_stream_name,
:timestamp,
:message,
:ingestion_time,
:event_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_identifier
# The name or ARN of the log group that contains the data protection
# policy that you want to see.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDataProtectionPolicyRequest AWS API Documentation
#
class GetDataProtectionPolicyRequest < Struct.new(
:log_group_identifier)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_identifier
# The log group name or ARN that you specified in your request.
# @return [String]
#
# @!attribute [rw] policy_document
# The data protection policy document for this log group.
# @return [String]
#
# @!attribute [rw] last_updated_time
# The date and time that this policy was most recently updated.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDataProtectionPolicyResponse AWS API Documentation
#
class GetDataProtectionPolicyResponse < Struct.new(
:log_group_identifier,
:policy_document,
:last_updated_time)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery_destination_name
# The name of the delivery destination that you want to retrieve the
# policy of.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryDestinationPolicyRequest AWS API Documentation
#
class GetDeliveryDestinationPolicyRequest < Struct.new(
:delivery_destination_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] policy
# The IAM policy for this delivery destination.
# @return [Types::Policy]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryDestinationPolicyResponse AWS API Documentation
#
class GetDeliveryDestinationPolicyResponse < Struct.new(
:policy)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] name
# The name of the delivery destination that you want to retrieve.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryDestinationRequest AWS API Documentation
#
class GetDeliveryDestinationRequest < Struct.new(
:name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery_destination
# A structure containing information about the delivery destination.
# @return [Types::DeliveryDestination]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryDestinationResponse AWS API Documentation
#
class GetDeliveryDestinationResponse < Struct.new(
:delivery_destination)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] id
# The ID of the delivery that you want to retrieve.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryRequest AWS API Documentation
#
class GetDeliveryRequest < Struct.new(
:id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery
# A structure that contains information about the delivery.
# @return [Types::Delivery]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliveryResponse AWS API Documentation
#
class GetDeliveryResponse < Struct.new(
:delivery)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] name
# The name of the delivery source that you want to retrieve.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliverySourceRequest AWS API Documentation
#
class GetDeliverySourceRequest < Struct.new(
:name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery_source
# A structure containing information about the delivery source.
# @return [Types::DeliverySource]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDeliverySourceResponse AWS API Documentation
#
class GetDeliverySourceResponse < Struct.new(
:delivery_source)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] anomaly_detector_arn
# The ARN of the anomaly detector to retrieve information about. You
# can find the ARNs of log anomaly detectors in your account by using
# the [ListLogAnomalyDetectors][1] operation.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogAnomalyDetectorRequest AWS API Documentation
#
class GetLogAnomalyDetectorRequest < Struct.new(
:anomaly_detector_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] detector_name
# The name of the log anomaly detector
# @return [String]
#
# @!attribute [rw] log_group_arn_list
# An array of structures, where each structure contains the ARN of a
# log group associated with this anomaly detector.
# @return [Array<String>]
#
# @!attribute [rw] evaluation_frequency
# Specifies how often the anomaly detector runs and look for
# anomalies. Set this value according to the frequency that the log
# group receives new logs. For example, if the log group receives new
# log events every 10 minutes, then setting `evaluationFrequency` to
# `FIFTEEN_MIN` might be appropriate.
# @return [String]
#
# @!attribute [rw] filter_pattern
# 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.
# @return [String]
#
# @!attribute [rw] anomaly_detector_status
# Specifies whether the anomaly detector is currently active. To
# change its status, use the `enabled` parameter in the
# [UpdateLogAnomalyDetector][1] operation.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html
# @return [String]
#
# @!attribute [rw] kms_key_id
# The ID of the KMS key assigned to this anomaly detector, if any.
# @return [String]
#
# @!attribute [rw] creation_time_stamp
# The date and time when this anomaly detector was created.
# @return [Integer]
#
# @!attribute [rw] last_modified_time_stamp
# The date and time when this anomaly detector was most recently
# modified.
# @return [Integer]
#
# @!attribute [rw] anomaly_visibility_time
# The number of days used as the life cycle of anomalies. After this
# time, anomalies are automatically baselined and the anomaly detector
# model will treat new occurrences of similar event as normal.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogAnomalyDetectorResponse AWS API Documentation
#
class GetLogAnomalyDetectorResponse < Struct.new(
:detector_name,
:log_group_arn_list,
:evaluation_frequency,
:filter_pattern,
:anomaly_detector_status,
:kms_key_id,
:creation_time_stamp,
:last_modified_time_stamp,
:anomaly_visibility_time)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
#
# <note markdown="1"> You must include either `logGroupIdentifier` or `logGroupName`, but
# not both.
#
# </note>
# @return [String]
#
# @!attribute [rw] log_group_identifier
# Specify either the name or ARN of the log group to view events from.
# If the log group is in a source account and you are using a
# monitoring account, you must use the log group ARN.
#
# <note markdown="1"> You must include either `logGroupIdentifier` or `logGroupName`, but
# not both.
#
# </note>
# @return [String]
#
# @!attribute [rw] log_stream_name
# The name of the log stream.
# @return [String]
#
# @!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 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 timestamp equal to
# or later than this time are not included.
# @return [Integer]
#
# @!attribute [rw] next_token
# The token for the next set of items to return. (You received this
# token from a previous call.)
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of log events returned. If you don't specify a
# limit, the default is as many log events as can fit in a response
# size of 1 MB (up to 10,000 log events).
# @return [Integer]
#
# @!attribute [rw] start_from_head
# 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`.
# @return [Boolean]
#
# @!attribute [rw] unmask
# Specify `true` to display the log event fields with all sensitive
# data unmasked and visible. The default is `false`.
#
# To use this operation with this parameter, you must be signed into
# an account with the `logs:Unmask` permission.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogEventsRequest AWS API Documentation
#
class GetLogEventsRequest < Struct.new(
:log_group_name,
:log_group_identifier,
:log_stream_name,
:start_time,
:end_time,
:next_token,
:limit,
:start_from_head,
:unmask)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] events
# The events.
# @return [Array<Types::OutputLogEvent>]
#
# @!attribute [rw] next_forward_token
# 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.
# @return [String]
#
# @!attribute [rw] next_backward_token
# The token for the next set of items in the backward direction. The
# token expires after 24 hours. This token is not null. If you have
# reached the end of the stream, it returns the same token you passed
# in.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogEventsResponse AWS API Documentation
#
class GetLogEventsResponse < Struct.new(
:events,
:next_forward_token,
:next_backward_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group to search.
#
# <note markdown="1"> You must include either `logGroupIdentifier` or `logGroupName`, but
# not both.
#
# </note>
# @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 most recent 15 minutes up to the current time
# are searched.
#
# The `time` value is specified as epoch time, which is the number of
# seconds since `January 1, 1970, 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] log_group_identifier
# Specify either the name or ARN of the log group to view. If the log
# group is in a source account and you are using a monitoring account,
# you must specify the ARN.
#
# <note markdown="1"> You must include either `logGroupIdentifier` or `logGroupName`, but
# not both.
#
# </note>
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFieldsRequest AWS API Documentation
#
class GetLogGroupFieldsRequest < Struct.new(
:log_group_name,
:time,
:log_group_identifier)
SENSITIVE = []
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)
SENSITIVE = []
include Aws::Structure
end
# @!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]
#
# @!attribute [rw] unmask
# Specify `true` to display the log event fields with all sensitive
# data unmasked and visible. The default is `false`.
#
# To use this operation with this parameter, you must be signed into
# an account with the `logs:Unmask` permission.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecordRequest AWS API Documentation
#
class GetLogRecordRequest < Struct.new(
:log_record_pointer,
:unmask)
SENSITIVE = []
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)
SENSITIVE = []
include Aws::Structure
end
# @!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)
SENSITIVE = []
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 scanned log events. These values reflect the full
# raw results of the query.
# @return [Types::QueryStatistics]
#
# @!attribute [rw] status
# 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 60 minutes of runtime. To avoid having your
# queries time out, reduce the time range being searched or partition
# your query into a number of queries.
# @return [String]
#
# @!attribute [rw] encryption_key
# If you associated an KMS key with the CloudWatch Logs Insights query
# results in this account, this field displays the ARN of the key
# that's used to encrypt the query results when [StartQuery][1]
# stores them.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
# @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,
:encryption_key)
SENSITIVE = []
include Aws::Structure
end
# Represents a log event, which is a record of activity that was
# recorded by the application or resource being monitored.
#
# @!attribute [rw] timestamp
# The time the event occurred, expressed as the number of milliseconds
# after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] message
# The raw event message. Each log event can be no larger than 256 KB.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/InputLogEvent AWS API Documentation
#
class InputLogEvent < Struct.new(
:timestamp,
:message)
SENSITIVE = []
include Aws::Structure
end
# The operation is not valid on the specified resource.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/InvalidOperationException AWS API Documentation
#
class InvalidOperationException < Aws::EmptyStructure; end
# A parameter is specified incorrectly.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/InvalidParameterException AWS API Documentation
#
class InvalidParameterException < Aws::EmptyStructure; end
# The sequence token is not valid. You can get the correct sequence
# token in the `expectedSequenceToken` field in the
# `InvalidSequenceTokenException` message.
#
# `PutLogEvents` actions are now always accepted and never return
# `InvalidSequenceTokenException` regardless of receiving an invalid
# sequence token.
#
# @!attribute [rw] expected_sequence_token
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/InvalidSequenceTokenException AWS API Documentation
#
class InvalidSequenceTokenException < Struct.new(
:expected_sequence_token)
SENSITIVE = []
include Aws::Structure
end
# You have reached the maximum number of resources that can be created.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LimitExceededException AWS API Documentation
#
class LimitExceededException < Aws::EmptyStructure; end
# @!attribute [rw] anomaly_detector_arn
# Use this to optionally limit the results to only the anomalies found
# by a certain anomaly detector.
# @return [String]
#
# @!attribute [rw] suppression_state
# You can specify this parameter if you want to the operation to
# return only anomalies that are currently either suppressed or
# unsuppressed.
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of items to return. If you don't specify a
# value, the default maximum value of 50 items is used.
# @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/ListAnomaliesRequest AWS API Documentation
#
class ListAnomaliesRequest < Struct.new(
:anomaly_detector_arn,
:suppression_state,
:limit,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] anomalies
# An array of structures, where each structure contains information
# about one anomaly that a log anomaly detector has found.
# @return [Array<Types::Anomaly>]
#
# @!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/ListAnomaliesResponse AWS API Documentation
#
class ListAnomaliesResponse < Struct.new(
:anomalies,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] filter_log_group_arn
# Use this to optionally filter the results to only include anomaly
# detectors that are associated with the specified log group.
# @return [String]
#
# @!attribute [rw] limit
# The maximum number of items to return. If you don't specify a
# value, the default maximum value of 50 items is used.
# @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/ListLogAnomalyDetectorsRequest AWS API Documentation
#
class ListLogAnomalyDetectorsRequest < Struct.new(
:filter_log_group_arn,
:limit,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] anomaly_detectors
# An array of structures, where each structure in the array contains
# information about one anomaly detector.
# @return [Array<Types::AnomalyDetector>]
#
# @!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/ListLogAnomalyDetectorsResponse AWS API Documentation
#
class ListLogAnomalyDetectorsResponse < Struct.new(
:anomaly_detectors,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] resource_arn
# The ARN of the resource that you want to view tags for.
#
# The ARN format of a log group is
# `arn:aws:logs:Region:account-id:log-group:log-group-name `
#
# The ARN format of a destination is
# `arn:aws:logs:Region:account-id:destination:destination-name `
#
# For more information about ARN format, see [CloudWatch Logs
# resources and operations][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsForResourceRequest AWS API Documentation
#
class ListTagsForResourceRequest < Struct.new(
:resource_arn)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] tags
# The list of tags associated with the requested resource.>
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsForResourceResponse AWS API Documentation
#
class ListTagsForResourceResponse < Struct.new(
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsLogGroupRequest AWS API Documentation
#
class ListTagsLogGroupRequest < Struct.new(
:log_group_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] tags
# The tags for the log group.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListTagsLogGroupResponse AWS API Documentation
#
class ListTagsLogGroupResponse < Struct.new(
:tags)
SENSITIVE = []
include Aws::Structure
end
# This object contains the information for one log event returned in a
# Live Tail stream.
#
# @!attribute [rw] log_stream_name
# The name of the log stream that ingested this log event.
# @return [String]
#
# @!attribute [rw] log_group_identifier
# The name or ARN of the log group that ingested this log event.
# @return [String]
#
# @!attribute [rw] message
# The log event message text.
# @return [String]
#
# @!attribute [rw] timestamp
# The timestamp specifying when this log event was created.
# @return [Integer]
#
# @!attribute [rw] ingestion_time
# The timestamp specifying when this log event was ingested into the
# log group.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LiveTailSessionLogEvent AWS API Documentation
#
class LiveTailSessionLogEvent < Struct.new(
:log_stream_name,
:log_group_identifier,
:message,
:timestamp,
:ingestion_time)
SENSITIVE = []
include Aws::Structure
end
# This object contains the metadata for one `LiveTailSessionUpdate`
# structure. It indicates whether that update includes only a sample of
# 500 log events out of a larger number of ingested log events, or if it
# contains all of the matching log events ingested during that second of
# time.
#
# @!attribute [rw] sampled
# If this is `true`, then more than 500 log events matched the request
# for this update, and the `sessionResults` includes a sample of 500
# of those events.
#
# If this is `false`, then 500 or fewer log events matched the request
# for this update, so no sampling was necessary. In this case, the
# `sessionResults` array includes all log events that matched your
# request during this time.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LiveTailSessionMetadata AWS API Documentation
#
class LiveTailSessionMetadata < Struct.new(
:sampled)
SENSITIVE = []
include Aws::Structure
end
# This object contains information about this Live Tail session,
# including the log groups included and the log stream filters, if any.
#
# @!attribute [rw] request_id
# The unique ID generated by CloudWatch Logs to identify this Live
# Tail session request.
# @return [String]
#
# @!attribute [rw] session_id
# The unique ID generated by CloudWatch Logs to identify this Live
# Tail session.
# @return [String]
#
# @!attribute [rw] log_group_identifiers
# An array of the names and ARNs of the log groups included in this
# Live Tail session.
# @return [Array<String>]
#
# @!attribute [rw] log_stream_names
# If your StartLiveTail operation request included a `logStreamNames`
# parameter that filtered the session to only include certain log
# streams, these streams are listed here.
# @return [Array<String>]
#
# @!attribute [rw] log_stream_name_prefixes
# If your StartLiveTail operation request included a
# `logStreamNamePrefixes` parameter that filtered the session to only
# include log streams that have names that start with certain
# prefixes, these prefixes are listed here.
# @return [Array<String>]
#
# @!attribute [rw] log_event_filter_pattern
# An optional pattern to filter the results to include only log events
# that match the pattern. For example, a filter pattern of `error 404`
# displays only log events that include both `error` and `404`.
#
# For more information about filter pattern syntax, see [Filter and
# Pattern Syntax][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LiveTailSessionStart AWS API Documentation
#
class LiveTailSessionStart < Struct.new(
:request_id,
:session_id,
:log_group_identifiers,
:log_stream_names,
:log_stream_name_prefixes,
:log_event_filter_pattern,
:event_type)
SENSITIVE = []
include Aws::Structure
end
# This object contains the log events and metadata for a Live Tail
# session.
#
# @!attribute [rw] session_metadata
# This object contains the session metadata for a Live Tail session.
# @return [Types::LiveTailSessionMetadata]
#
# @!attribute [rw] session_results
# An array, where each member of the array includes the information
# for one log event in the Live Tail session.
#
# A `sessionResults` array can include as many as 500 log events. If
# the number of log events matching the request exceeds 500 per
# second, the log events are sampled down to 500 log events to be
# included in each `sessionUpdate` structure.
# @return [Array<Types::LiveTailSessionLogEvent>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LiveTailSessionUpdate AWS API Documentation
#
class LiveTailSessionUpdate < Struct.new(
:session_metadata,
:session_results,
:event_type)
SENSITIVE = []
include Aws::Structure
end
# This structure contains the information for one sample log event that
# is associated with an anomaly found by a log anomaly detector.
#
# @!attribute [rw] timestamp
# The time stamp of the log event.
# @return [Integer]
#
# @!attribute [rw] message
# The message content of the log event.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LogEvent AWS API Documentation
#
class LogEvent < Struct.new(
:timestamp,
:message)
SENSITIVE = []
include Aws::Structure
end
# Represents a log group.
#
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] creation_time
# The creation time of the log group, expressed as the number of
# milliseconds after Jan 1, 1970 00:00:00 UTC.
# @return [Integer]
#
# @!attribute [rw] retention_in_days
# The number of days to retain the log events in the specified log
# group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150,
# 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and
# 3653.
#
# To set a log group so that its log events do not expire, use
# [DeleteRetentionPolicy][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html
# @return [Integer]
#
# @!attribute [rw] metric_filter_count
# The number of metric filters.
# @return [Integer]
#
# @!attribute [rw] arn
# The Amazon Resource Name (ARN) of the log group. This version of the
# ARN includes a trailing `:*` after the log group name.
#
# Use this version to refer to the ARN in IAM policies when specifying
# permissions for most API actions. The exception is when specifying
# permissions for [TagResource][1], [UntagResource][2], and
# [ListTagsForResource][3]. The permissions for those three actions
# require the ARN version that doesn't include a trailing `:*`.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html
# [3]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html
# @return [String]
#
# @!attribute [rw] stored_bytes
# The number of bytes stored.
# @return [Integer]
#
# @!attribute [rw] kms_key_id
# The Amazon Resource Name (ARN) of the KMS key to use when encrypting
# log data.
# @return [String]
#
# @!attribute [rw] data_protection_status
# Displays whether this log group has a protection policy, or whether
# it had one in the past. For more information, see
# [PutDataProtectionPolicy][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html
# @return [String]
#
# @!attribute [rw] inherited_properties
# Displays all the properties that this log group has inherited from
# account-level settings.
# @return [Array<String>]
#
# @!attribute [rw] log_group_class
# This specifies the log group class for this log group. There are two
# classes:
#
# * The `Standard` log class supports all CloudWatch Logs features.
#
# * The `Infrequent Access` log class supports a subset of CloudWatch
# Logs features and incurs lower costs.
#
# For details about the features supported by each class, see [Log
# classes][1]
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html
# @return [String]
#
# @!attribute [rw] log_group_arn
# The Amazon Resource Name (ARN) of the log group. This version of the
# ARN doesn't include a trailing `:*` after the log group name.
#
# Use this version to refer to the ARN in the following situations:
#
# * In the `logGroupIdentifier` input field in many CloudWatch Logs
# APIs.
#
# * In the `resourceArn` field in tagging APIs
#
# * In IAM policies, when specifying permissions for [TagResource][1],
# [UntagResource][2], and [ListTagsForResource][3].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html
# [3]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LogGroup AWS API Documentation
#
class LogGroup < Struct.new(
:log_group_name,
:creation_time,
:retention_in_days,
:metric_filter_count,
:arn,
:stored_bytes,
:kms_key_id,
:data_protection_status,
:inherited_properties,
:log_group_class,
:log_group_arn)
SENSITIVE = []
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)
SENSITIVE = []
include Aws::Structure
end
# Represents a log stream, which is a sequence of log events from a
# single emitter of logs.
#
# @!attribute [rw] log_stream_name
# The name of the log stream.
# @return [String]
#
# @!attribute [rw] creation_time
# The creation time of the stream, expressed as the number of
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] first_event_timestamp
# The time of the first event, expressed as the number of milliseconds
# after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] last_event_timestamp
# 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.
# @return [Integer]
#
# @!attribute [rw] last_ingestion_time
# The ingestion time, expressed as the number of milliseconds after
# `Jan 1, 1970 00:00:00 UTC` The `lastIngestionTime` value updates on
# an eventual consistency basis. It typically updates in less than an
# hour after ingestion, but in rare situations might take longer.
# @return [Integer]
#
# @!attribute [rw] upload_sequence_token
# The sequence token.
#
# The sequence token is now ignored in `PutLogEvents` actions.
# `PutLogEvents` actions are always accepted regardless of receiving
# an invalid sequence token. You don't need to obtain
# `uploadSequenceToken` to use a `PutLogEvents` action.
# @return [String]
#
# @!attribute [rw] arn
# The Amazon Resource Name (ARN) of the log stream.
# @return [String]
#
# @!attribute [rw] stored_bytes
# The number of bytes stored.
#
# **Important:** As of June 17, 2019, this parameter is no longer
# supported for log streams, and is always reported as zero. This
# change applies only to log streams. The `storedBytes` parameter for
# log groups is not affected.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LogStream AWS API Documentation
#
class LogStream < Struct.new(
:log_stream_name,
:creation_time,
:first_event_timestamp,
:last_event_timestamp,
:last_ingestion_time,
:upload_sequence_token,
:arn,
:stored_bytes)
SENSITIVE = []
include Aws::Structure
end
# The query string is not valid. Details about this error are displayed
# in a `QueryCompileError` object. For more information, see
# [QueryCompileError][1].
#
# For more information about valid query syntax, see [CloudWatch Logs
# Insights Query Syntax][2].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_QueryCompileError.html
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html
#
# @!attribute [rw] query_compile_error
# Reserved.
# @return [Types::QueryCompileError]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/MalformedQueryException AWS API Documentation
#
class MalformedQueryException < Struct.new(
:query_compile_error)
SENSITIVE = []
include Aws::Structure
end
# Metric filters express how CloudWatch Logs would extract metric
# observations from ingested log events and transform them into metric
# data in a CloudWatch metric.
#
# @!attribute [rw] filter_name
# The name of the metric filter.
# @return [String]
#
# @!attribute [rw] filter_pattern
# 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.
# @return [String]
#
# @!attribute [rw] metric_transformations
# The metric transformations.
# @return [Array<Types::MetricTransformation>]
#
# @!attribute [rw] creation_time
# The creation time of the metric filter, expressed as the number of
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/MetricFilter AWS API Documentation
#
class MetricFilter < Struct.new(
:filter_name,
:filter_pattern,
:metric_transformations,
:creation_time,
:log_group_name)
SENSITIVE = []
include Aws::Structure
end
# Represents a matched event.
#
# @!attribute [rw] event_number
# The event number.
# @return [Integer]
#
# @!attribute [rw] event_message
# The raw event data.
# @return [String]
#
# @!attribute [rw] extracted_values
# The values extracted from the event data by the filter.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/MetricFilterMatchRecord AWS API Documentation
#
class MetricFilterMatchRecord < Struct.new(
:event_number,
:event_message,
:extracted_values)
SENSITIVE = []
include Aws::Structure
end
# Indicates how to transform ingested log events to metric data in a
# CloudWatch metric.
#
# @!attribute [rw] metric_name
# The name of the CloudWatch metric.
# @return [String]
#
# @!attribute [rw] metric_namespace
# A custom namespace to contain your metric in CloudWatch. Use
# namespaces to group together metrics that are similar. For more
# information, see [Namespaces][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace
# @return [String]
#
# @!attribute [rw] metric_value
# The value to publish to the CloudWatch metric when a filter pattern
# matches a log event.
# @return [String]
#
# @!attribute [rw] default_value
# (Optional) The value to emit when a filter pattern does not match a
# log event. This value can be null.
# @return [Float]
#
# @!attribute [rw] dimensions
# The fields to use as dimensions for the metric. One metric filter
# can include as many as three dimensions.
#
# Metrics extracted from log events are charged as custom metrics. To
# prevent unexpected high charges, do not specify high-cardinality
# fields such as `IPAddress` or `requestID` as dimensions. Each
# different value found for a dimension is treated as a separate
# metric and accrues charges as a separate custom metric.
#
# CloudWatch Logs disables a metric filter if it generates 1000
# different name/value pairs for your specified dimensions within a
# certain amount of time. This helps to prevent accidental high
# charges.
#
# You can also set up a billing alarm to alert you if your charges
# are
# higher than expected. For more information, see [ Creating a Billing
# Alarm to Monitor Your Estimated Amazon Web Services Charges][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html
# @return [Hash<String,String>]
#
# @!attribute [rw] unit
# The unit to assign to the metric. If you omit this, the unit is set
# as `None`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/MetricTransformation AWS API Documentation
#
class MetricTransformation < Struct.new(
:metric_name,
:metric_namespace,
:metric_value,
:default_value,
:dimensions,
:unit)
SENSITIVE = []
include Aws::Structure
end
# Multiple concurrent requests to update the same resource were in
# conflict.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OperationAbortedException AWS API Documentation
#
class OperationAbortedException < Aws::EmptyStructure; end
# Represents a log event.
#
# @!attribute [rw] timestamp
# The time the event occurred, expressed as the number of milliseconds
# after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @!attribute [rw] message
# The data contained in the log event.
# @return [String]
#
# @!attribute [rw] ingestion_time
# The time the event was ingested, expressed as the number of
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OutputLogEvent AWS API Documentation
#
class OutputLogEvent < Struct.new(
:timestamp,
:message,
:ingestion_time)
SENSITIVE = []
include Aws::Structure
end
# A tructures that contains information about one pattern token related
# to an anomaly.
#
# For more information about patterns and tokens, see
# [CreateLogAnomalyDetector][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html
#
# @!attribute [rw] dynamic_token_position
# For a dynamic token, this indicates where in the pattern that this
# token appears, related to other dynamic tokens. The dynamic token
# that appears first has a value of `1`, the one that appears second
# is `2`, and so on.
# @return [Integer]
#
# @!attribute [rw] is_dynamic
# Specifies whether this is a dynamic token.
# @return [Boolean]
#
# @!attribute [rw] token_string
# The string represented by this token. If this is a dynamic token,
# the value will be `<*>`
# @return [String]
#
# @!attribute [rw] enumerations
# Contains the values found for a dynamic token, and the number of
# times each value was found.
# @return [Hash<String,Integer>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PatternToken AWS API Documentation
#
class PatternToken < Struct.new(
:dynamic_token_position,
:is_dynamic,
:token_string,
:enumerations)
SENSITIVE = []
include Aws::Structure
end
# A structure that contains information about one delivery destination
# policy.
#
# @!attribute [rw] delivery_destination_policy
# The contents of the delivery destination policy.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/Policy AWS API Documentation
#
class Policy < Struct.new(
:delivery_destination_policy)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] policy_name
# A name for the policy. This must be unique within the account.
# @return [String]
#
# @!attribute [rw] policy_document
# Specify the policy, in JSON.
#
# **Data protection policy**
#
# A data protection policy must include two JSON blocks:
#
# * The first block must include both a `DataIdentifer` array and an
# `Operation` property with an `Audit` action. The `DataIdentifer`
# array lists the types of sensitive data that you want to mask. For
# more information about the available options, see [Types of data
# that you can mask][1].
#
# The `Operation` property with an `Audit` action is required to
# find the sensitive data terms. This `Audit` action must contain a
# `FindingsDestination` object. You can optionally use that
# `FindingsDestination` object to list one or more destinations to
# send audit findings to. If you specify destinations such as log
# groups, Firehose streams, and S3 buckets, they must already exist.
#
# * The second block must include both a `DataIdentifer` array and an
# `Operation` property with an `Deidentify` action. The
# `DataIdentifer` array must exactly match the `DataIdentifer` array
# in the first block of the policy.
#
# The `Operation` property with the `Deidentify` action is what
# actually masks the data, and it must contain the ` "MaskConfig":
# \{\}` object. The ` "MaskConfig": \{\}` object must be empty.
#
# For an example data protection policy, see the **Examples** section
# on this page.
#
# The contents of the two `DataIdentifer` arrays must match exactly.
#
# In addition to the two JSON blocks, the `policyDocument` can also
# include `Name`, `Description`, and `Version` fields. The `Name` is
# different than the operation's `policyName` parameter, and is used
# as a dimension when CloudWatch Logs reports audit findings metrics
# to CloudWatch.
#
# The JSON specified in `policyDocument` can be up to 30,720
# characters long.
#
# **Subscription filter policy**
#
# A subscription filter policy can include the following attributes in
# a JSON block:
#
# * **DestinationArn** The ARN of the destination to deliver log
# events to. Supported destinations are:
#
# * An Kinesis Data Streams data stream in the same account as the
# subscription policy, for same-account delivery.
#
# * An Firehose data stream in the same account as the subscription
# policy, for same-account delivery.
#
# * A Lambda function in the same account as the subscription
# policy, for same-account delivery.
#
# * A logical destination in a different account created with
# [PutDestination][2], for cross-account delivery. Kinesis Data
# Streams and Firehose are supported as logical destinations.
#
# * **RoleArn** 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.
#
# * **FilterPattern** A filter pattern for subscribing to a filtered
# stream of log events.
#
# * **Distribution**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
# Kinesis Data Streams data stream.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html
# @return [String]
#
# @!attribute [rw] policy_type
# The type of policy that you're creating or updating.
# @return [String]
#
# @!attribute [rw] scope
# Currently the only valid value for this parameter is `ALL`, which
# specifies that the data protection policy applies to all log groups
# in the account. If you omit this parameter, the default of `ALL` is
# used.
# @return [String]
#
# @!attribute [rw] selection_criteria
# Use this parameter to apply the subscription filter policy to a
# subset of log groups in the account. Currently, the only supported
# filter is `LogGroupName NOT IN []`. The `selectionCriteria` string
# can be up to 25KB in length. The length is determined by using its
# UTF-8 bytes.
#
# Using the `selectionCriteria` parameter is useful to help prevent
# infinite loops. For more information, see [Log recursion
# prevention][1].
#
# Specifing `selectionCriteria` is valid only when you specify `
# SUBSCRIPTION_FILTER_POLICY` for `policyType`.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions-recursion-prevention.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutAccountPolicyRequest AWS API Documentation
#
class PutAccountPolicyRequest < Struct.new(
:policy_name,
:policy_document,
:policy_type,
:scope,
:selection_criteria)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] account_policy
# The account policy that you created.
# @return [Types::AccountPolicy]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutAccountPolicyResponse AWS API Documentation
#
class PutAccountPolicyResponse < Struct.new(
:account_policy)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_identifier
# Specify either the log group name or log group ARN.
# @return [String]
#
# @!attribute [rw] policy_document
# Specify the data protection policy, in JSON.
#
# This policy must include two JSON blocks:
#
# * The first block must include both a `DataIdentifer` array and an
# `Operation` property with an `Audit` action. The `DataIdentifer`
# array lists the types of sensitive data that you want to mask. For
# more information about the available options, see [Types of data
# that you can mask][1].
#
# The `Operation` property with an `Audit` action is required to
# find the sensitive data terms. This `Audit` action must contain a
# `FindingsDestination` object. You can optionally use that
# `FindingsDestination` object to list one or more destinations to
# send audit findings to. If you specify destinations such as log
# groups, Firehose streams, and S3 buckets, they must already exist.
#
# * The second block must include both a `DataIdentifer` array and an
# `Operation` property with an `Deidentify` action. The
# `DataIdentifer` array must exactly match the `DataIdentifer` array
# in the first block of the policy.
#
# The `Operation` property with the `Deidentify` action is what
# actually masks the data, and it must contain the ` "MaskConfig":
# \{\}` object. The ` "MaskConfig": \{\}` object must be empty.
#
# For an example data protection policy, see the **Examples** section
# on this page.
#
# The contents of the two `DataIdentifer` arrays must match exactly.
#
# In addition to the two JSON blocks, the `policyDocument` can also
# include `Name`, `Description`, and `Version` fields. The `Name` is
# used as a dimension when CloudWatch Logs reports audit findings
# metrics to CloudWatch.
#
# The JSON specified in `policyDocument` can be up to 30,720
# characters.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDataProtectionPolicyRequest AWS API Documentation
#
class PutDataProtectionPolicyRequest < Struct.new(
:log_group_identifier,
:policy_document)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_identifier
# The log group name or ARN that you specified in your request.
# @return [String]
#
# @!attribute [rw] policy_document
# The data protection policy used for this log group.
# @return [String]
#
# @!attribute [rw] last_updated_time
# The date and time that this policy was most recently updated.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDataProtectionPolicyResponse AWS API Documentation
#
class PutDataProtectionPolicyResponse < Struct.new(
:log_group_identifier,
:policy_document,
:last_updated_time)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery_destination_name
# The name of the delivery destination to assign this policy to.
# @return [String]
#
# @!attribute [rw] delivery_destination_policy
# The contents of the policy.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliveryDestinationPolicyRequest AWS API Documentation
#
class PutDeliveryDestinationPolicyRequest < Struct.new(
:delivery_destination_name,
:delivery_destination_policy)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] policy
# The contents of the policy that you just created.
# @return [Types::Policy]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliveryDestinationPolicyResponse AWS API Documentation
#
class PutDeliveryDestinationPolicyResponse < Struct.new(
:policy)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] name
# A name for this delivery destination. This name must be unique for
# all delivery destinations in your account.
# @return [String]
#
# @!attribute [rw] output_format
# The format for the logs that this delivery destination will receive.
# @return [String]
#
# @!attribute [rw] delivery_destination_configuration
# A structure that contains the ARN of the Amazon Web Services
# resource that will receive the logs.
# @return [Types::DeliveryDestinationConfiguration]
#
# @!attribute [rw] tags
# An optional list of key-value pairs to associate with the resource.
#
# For more information about tagging, see [Tagging Amazon Web Services
# resources][1]
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliveryDestinationRequest AWS API Documentation
#
class PutDeliveryDestinationRequest < Struct.new(
:name,
:output_format,
:delivery_destination_configuration,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery_destination
# A structure containing information about the delivery destination
# that you just created or updated.
# @return [Types::DeliveryDestination]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliveryDestinationResponse AWS API Documentation
#
class PutDeliveryDestinationResponse < Struct.new(
:delivery_destination)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] name
# A name for this delivery source. This name must be unique for all
# delivery sources in your account.
# @return [String]
#
# @!attribute [rw] resource_arn
# The ARN of the Amazon Web Services resource that is generating and
# sending logs. For example,
# `arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234`
# @return [String]
#
# @!attribute [rw] log_type
# Defines the type of log that the source is sending.
#
# * For Amazon CodeWhisperer, the valid value is `EVENT_LOGS`.
#
# * For IAM Identity Centerr, the valid value is `ERROR_LOGS`.
#
# * For Amazon WorkMail, the valid values are `ACCESS_CONTROL_LOGS`,
# `AUTHENTICATION_LOGS`, `WORKMAIL_AVAILABILITY_PROVIDER_LOGS`, and
# `WORKMAIL_MAILBOX_ACCESS_LOGS`.
# @return [String]
#
# @!attribute [rw] tags
# An optional list of key-value pairs to associate with the resource.
#
# For more information about tagging, see [Tagging Amazon Web Services
# resources][1]
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliverySourceRequest AWS API Documentation
#
class PutDeliverySourceRequest < Struct.new(
:name,
:resource_arn,
:log_type,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] delivery_source
# A structure containing information about the delivery source that
# was just created or updated.
# @return [Types::DeliverySource]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDeliverySourceResponse AWS API Documentation
#
class PutDeliverySourceResponse < Struct.new(
:delivery_source)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] destination_name
# A name for an existing destination.
# @return [String]
#
# @!attribute [rw] access_policy
# 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.
# @return [String]
#
# @!attribute [rw] force_update
# Specify true if you are updating an existing destination policy to
# grant permission to an organization ID instead of granting
# permission to individual Amazon Web Services accounts. Before you
# update a destination policy this way, you must first update the
# subscription filters in the accounts that send logs to this
# destination. If you do not, the subscription filters might stop
# working. By specifying `true` for `forceUpdate`, you are affirming
# that you have already updated the subscription filters. For more
# information, see [ Updating an existing cross-account
# subscription][1]
#
# If you omit this parameter, the default of `false` is used.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Cross-Account-Log_Subscription-Update.html
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestinationPolicyRequest AWS API Documentation
#
class PutDestinationPolicyRequest < Struct.new(
:destination_name,
:access_policy,
:force_update)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] destination_name
# A name for the destination.
# @return [String]
#
# @!attribute [rw] target_arn
# The ARN of an Amazon Kinesis stream to which to deliver matching log
# events.
# @return [String]
#
# @!attribute [rw] role_arn
# The ARN of an IAM role that grants CloudWatch Logs permissions to
# call the Amazon Kinesis `PutRecord` operation on the destination
# stream.
# @return [String]
#
# @!attribute [rw] tags
# An optional list of key-value pairs to associate with the resource.
#
# For more information about tagging, see [Tagging Amazon Web Services
# resources][1]
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestinationRequest AWS API Documentation
#
class PutDestinationRequest < Struct.new(
:destination_name,
:target_arn,
:role_arn,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] destination
# The destination.
# @return [Types::Destination]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDestinationResponse AWS API Documentation
#
class PutDestinationResponse < Struct.new(
:destination)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] log_stream_name
# The name of the log stream.
# @return [String]
#
# @!attribute [rw] log_events
# The log events.
# @return [Array<Types::InputLogEvent>]
#
# @!attribute [rw] sequence_token
# The sequence token obtained from the response of the previous
# `PutLogEvents` call.
#
# The `sequenceToken` parameter is now ignored in `PutLogEvents`
# actions. `PutLogEvents` actions are now accepted and never return
# `InvalidSequenceTokenException` or `DataAlreadyAcceptedException`
# even if the sequence token is not valid.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutLogEventsRequest AWS API Documentation
#
class PutLogEventsRequest < Struct.new(
:log_group_name,
:log_stream_name,
:log_events,
:sequence_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] next_sequence_token
# The next sequence token.
#
# This field has been deprecated.
#
# The sequence token is now ignored in `PutLogEvents` actions.
# `PutLogEvents` actions are always accepted even if the sequence
# token is not valid. You can use parallel `PutLogEvents` actions on
# the same log stream and you do not need to wait for the response of
# a previous `PutLogEvents` action to obtain the `nextSequenceToken`
# value.
# @return [String]
#
# @!attribute [rw] rejected_log_events_info
# The rejected events.
# @return [Types::RejectedLogEventsInfo]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutLogEventsResponse AWS API Documentation
#
class PutLogEventsResponse < Struct.new(
:next_sequence_token,
:rejected_log_events_info)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] filter_name
# A name for the metric filter.
# @return [String]
#
# @!attribute [rw] filter_pattern
# A filter pattern for extracting metric data out of ingested log
# events.
# @return [String]
#
# @!attribute [rw] metric_transformations
# A collection of information that defines how metric data gets
# emitted.
# @return [Array<Types::MetricTransformation>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutMetricFilterRequest AWS API Documentation
#
class PutMetricFilterRequest < Struct.new(
:log_group_name,
:filter_name,
:filter_pattern,
:metric_transformations)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] name
# A name for the query definition. If you are saving numerous query
# definitions, we recommend that you name them. This way, you can find
# the ones you want by using the first part of the name as a filter in
# the `queryDefinitionNamePrefix` parameter of
# [DescribeQueryDefinitions][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html
# @return [String]
#
# @!attribute [rw] query_definition_id
# 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][1] 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.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html
# @return [String]
#
# @!attribute [rw] log_group_names
# 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.
# @return [Array<String>]
#
# @!attribute [rw] query_string
# The query string to use for this definition. For more information,
# see [CloudWatch Logs Insights Query Syntax][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html
# @return [String]
#
# @!attribute [rw] client_token
# Used as an idempotency token, to avoid returning an exception if the
# service receives the same request twice because of a network error.
#
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutQueryDefinitionRequest AWS API Documentation
#
class PutQueryDefinitionRequest < Struct.new(
:name,
:query_definition_id,
:log_group_names,
:query_string,
:client_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] query_definition_id
# The ID of the query definition.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutQueryDefinitionResponse AWS API Documentation
#
class PutQueryDefinitionResponse < Struct.new(
:query_definition_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] policy_name
# Name of the new policy. This parameter is required.
# @return [String]
#
# @!attribute [rw] policy_document
# 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][1] and
# [aws:SourceAccount][2] condition context keys.
#
# In the example resource policy, you would replace the value of
# `SourceArn` with the resource making the call from Route 53 to
# CloudWatch Logs. You would also replace the value of `SourceAccount`
# with the Amazon Web Services account ID making that call.
#
#
#
# `\{ "Version": "2012-10-17", "Statement": [ \{ "Sid":
# "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": \{
# "Service": [ "route53.amazonaws.com" ] \}, "Action":
# "logs:PutLogEvents", "Resource": "logArn", "Condition": \{
# "ArnLike": \{ "aws:SourceArn": "myRoute53ResourceArn" \},
# "StringEquals": \{ "aws:SourceAccount": "myAwsAccountId" \} \} \} ]
# \}`
#
#
#
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutResourcePolicyRequest AWS API Documentation
#
class PutResourcePolicyRequest < Struct.new(
:policy_name,
:policy_document)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] resource_policy
# The new policy.
# @return [Types::ResourcePolicy]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutResourcePolicyResponse AWS API Documentation
#
class PutResourcePolicyResponse < Struct.new(
:resource_policy)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] retention_in_days
# The number of days to retain the log events in the specified log
# group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150,
# 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and
# 3653.
#
# To set a log group so that its log events do not expire, use
# [DeleteRetentionPolicy][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutRetentionPolicyRequest AWS API Documentation
#
class PutRetentionPolicyRequest < Struct.new(
:log_group_name,
:retention_in_days)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] filter_name
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html
# @return [String]
#
# @!attribute [rw] filter_pattern
# A filter pattern for subscribing to a filtered stream of log events.
# @return [String]
#
# @!attribute [rw] destination_arn
# The ARN of the destination to deliver matching log events to.
# Currently, the supported destinations are:
#
# * An Amazon Kinesis stream belonging to the same account as the
# subscription filter, for same-account delivery.
#
# * A logical destination (specified using an ARN) belonging to a
# different account, for cross-account delivery.
#
# If you're setting up a cross-account subscription, the
# destination must have an IAM policy associated with it. The IAM
# policy must allow the sender to send logs to the destination. For
# more information, see [PutDestinationPolicy][1].
#
# * A Kinesis Data Firehose delivery stream belonging to the same
# account as the subscription filter, for same-account delivery.
#
# * A Lambda function belonging to the same account as the
# subscription filter, for same-account delivery.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html
# @return [String]
#
# @!attribute [rw] role_arn
# 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.
# @return [String]
#
# @!attribute [rw] distribution
# The method used to distribute log data to the destination. By
# default, log data is grouped by log stream, but the grouping can be
# set to random for a more even distribution. This property is only
# applicable when the destination is an Amazon Kinesis data stream.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutSubscriptionFilterRequest AWS API Documentation
#
class PutSubscriptionFilterRequest < Struct.new(
:log_group_name,
:filter_name,
:filter_pattern,
:destination_arn,
:role_arn,
:distribution)
SENSITIVE = []
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)
SENSITIVE = []
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)
SENSITIVE = []
include Aws::Structure
end
# This structure contains details about a saved CloudWatch Logs Insights
# query definition.
#
# @!attribute [rw] query_definition_id
# The unique ID of the query definition.
# @return [String]
#
# @!attribute [rw] name
# The name of the query definition.
# @return [String]
#
# @!attribute [rw] query_string
# The query string to use for this definition. For more information,
# see [CloudWatch Logs Insights Query Syntax][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html
# @return [String]
#
# @!attribute [rw] last_modified
# The date that the query definition was most recently modified.
# @return [Integer]
#
# @!attribute [rw] log_group_names
# If this query definition contains a list of log groups that it is
# limited to, that list appears here.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryDefinition AWS API Documentation
#
class QueryDefinition < Struct.new(
:query_definition_id,
:name,
:query_string,
:last_modified,
:log_group_names)
SENSITIVE = []
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)
SENSITIVE = []
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)
SENSITIVE = []
include Aws::Structure
end
# Represents the rejected events.
#
# @!attribute [rw] too_new_log_event_start_index
# The index of the first log event that is too new. This field is
# inclusive.
# @return [Integer]
#
# @!attribute [rw] too_old_log_event_end_index
# The index of the last log event that is too old. This field is
# exclusive.
# @return [Integer]
#
# @!attribute [rw] expired_log_event_end_index
# The expired log events.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/RejectedLogEventsInfo AWS API Documentation
#
class RejectedLogEventsInfo < Struct.new(
:too_new_log_event_start_index,
:too_old_log_event_end_index,
:expired_log_event_end_index)
SENSITIVE = []
include Aws::Structure
end
# The specified resource already exists.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ResourceAlreadyExistsException AWS API Documentation
#
class ResourceAlreadyExistsException < Aws::EmptyStructure; end
# The specified resource does not exist.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ResourceNotFoundException AWS API Documentation
#
class ResourceNotFoundException < Aws::EmptyStructure; end
# A policy enabling one or more entities to put logs to a log group in
# this account.
#
# @!attribute [rw] policy_name
# The name of the resource policy.
# @return [String]
#
# @!attribute [rw] policy_document
# The details of the policy.
# @return [String]
#
# @!attribute [rw] last_updated_time
# Timestamp showing when this policy was last updated, expressed as
# the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ResourcePolicy AWS API Documentation
#
class ResourcePolicy < Struct.new(
:policy_name,
:policy_document,
:last_updated_time)
SENSITIVE = []
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.
#
# For more information about the fields that are generated by CloudWatch
# logs, see [Supported Logs and Discovered Fields][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html
#
# @!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)
SENSITIVE = []
include Aws::Structure
end
# Represents the search status of a log stream.
#
# @!attribute [rw] log_stream_name
# The name of the log stream.
# @return [String]
#
# @!attribute [rw] searched_completely
# Indicates whether all the events in this log stream were searched.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/SearchedLogStream AWS API Documentation
#
class SearchedLogStream < Struct.new(
:log_stream_name,
:searched_completely)
SENSITIVE = []
include Aws::Structure
end
# This request exceeds a service quota.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ServiceQuotaExceededException AWS API Documentation
#
class ServiceQuotaExceededException < Aws::EmptyStructure; end
# The service cannot complete the request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ServiceUnavailableException AWS API Documentation
#
class ServiceUnavailableException < Aws::EmptyStructure; end
# his exception is returned if an unknown error occurs during a Live
# Tail session.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/SessionStreamingException AWS API Documentation
#
class SessionStreamingException < Struct.new(
:message,
:event_type)
SENSITIVE = []
include Aws::Structure
end
# This exception is returned in a Live Tail stream when the Live Tail
# session times out. Live Tail sessions time out after three hours.
#
# @!attribute [rw] message
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/SessionTimeoutException AWS API Documentation
#
class SessionTimeoutException < Struct.new(
:message,
:event_type)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_identifiers
# An array where each item in the array is a log group to include in
# the Live Tail session.
#
# Specify each log group by its ARN.
#
# If you specify an ARN, the ARN can't end with an asterisk (*).
#
# <note markdown="1"> You can include up to 10 log groups.
#
# </note>
# @return [Array<String>]
#
# @!attribute [rw] log_stream_names
# If you specify this parameter, then only log events in the log
# streams that you specify here are included in the Live Tail session.
#
# If you specify this field, you can't also specify the
# `logStreamNamePrefixes` field.
#
# <note markdown="1"> You can specify this parameter only if you specify only one log
# group in `logGroupIdentifiers`.
#
# </note>
# @return [Array<String>]
#
# @!attribute [rw] log_stream_name_prefixes
# If you specify this parameter, then only log events in the log
# streams that have names that start with the prefixes that you
# specify here are included in the Live Tail session.
#
# If you specify this field, you can't also specify the
# `logStreamNames` field.
#
# <note markdown="1"> You can specify this parameter only if you specify only one log
# group in `logGroupIdentifiers`.
#
# </note>
# @return [Array<String>]
#
# @!attribute [rw] log_event_filter_pattern
# An optional pattern to use to filter the results to include only log
# events that match the pattern. For example, a filter pattern of
# `error 404` causes only log events that include both `error` and
# `404` to be included in the Live Tail stream.
#
# Regular expression filter patterns are supported.
#
# For more information about filter pattern syntax, see [Filter and
# Pattern Syntax][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartLiveTailRequest AWS API Documentation
#
class StartLiveTailRequest < Struct.new(
:log_group_identifiers,
:log_stream_names,
:log_stream_name_prefixes,
:log_event_filter_pattern)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] response_stream
# An object that includes the stream returned by your request. It can
# include both log events and exceptions.
# @return [Types::StartLiveTailResponseStream]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartLiveTailResponse AWS API Documentation
#
class StartLiveTailResponse < Struct.new(
:response_stream)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The log group on which to perform the query.
#
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
# parameters: `logGroupName`, `logGroupNames`, or
# `logGroupIdentifiers`.
#
# </note>
# @return [String]
#
# @!attribute [rw] log_group_names
# The list of log groups to be queried. You can include up to 50 log
# groups.
#
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
# parameters: `logGroupName`, `logGroupNames`, or
# `logGroupIdentifiers`.
#
# </note>
# @return [Array<String>]
#
# @!attribute [rw] log_group_identifiers
# The list of log groups to query. You can include up to 50 log
# groups.
#
# You can specify them by the log group name or ARN. If a log group
# that you're querying is in a source account and you're using a
# monitoring account, you must specify the ARN of the log group here.
# The query definition must also be defined in the monitoring account.
#
# If you specify an ARN, the ARN can't end with an asterisk (*).
#
# A `StartQuery` operation must include exactly one of the following
# parameters: `logGroupName`, `logGroupNames`, or
# `logGroupIdentifiers`.
# @return [Array<String>]
#
# @!attribute [rw] start_time
# 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`.
# @return [Integer]
#
# @!attribute [rw] end_time
# 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`.
# @return [Integer]
#
# @!attribute [rw] query_string
# The query string to use. For more information, see [CloudWatch Logs
# Insights Query Syntax][1].
#
#
#
# [1]: https://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. The default is 1000.
# @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,
:log_group_names,
:log_group_identifiers,
:start_time,
:end_time,
:query_string,
:limit)
SENSITIVE = []
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)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] query_id
# The ID number of the query to stop. To find this ID number, use
# `DescribeQueries`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StopQueryRequest AWS API Documentation
#
class StopQueryRequest < Struct.new(
:query_id)
SENSITIVE = []
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)
SENSITIVE = []
include Aws::Structure
end
# Represents a subscription filter.
#
# @!attribute [rw] filter_name
# The name of the subscription filter.
# @return [String]
#
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] filter_pattern
# 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.
# @return [String]
#
# @!attribute [rw] destination_arn
# The Amazon Resource Name (ARN) of the destination.
# @return [String]
#
# @!attribute [rw] role_arn
# @return [String]
#
# @!attribute [rw] distribution
# The method used to distribute log data to the destination, which can
# be either random or grouped by log stream.
# @return [String]
#
# @!attribute [rw] creation_time
# The creation time of the subscription filter, expressed as the
# number of milliseconds after `Jan 1, 1970 00:00:00 UTC`.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/SubscriptionFilter AWS API Documentation
#
class SubscriptionFilter < Struct.new(
:filter_name,
:log_group_name,
:filter_pattern,
:destination_arn,
:role_arn,
:distribution,
:creation_time)
SENSITIVE = []
include Aws::Structure
end
# If you are suppressing an anomaly temporariliy, this structure defines
# how long the suppression period is to be.
#
# @!attribute [rw] value
# Specifies the number of seconds, minutes or hours to suppress this
# anomaly. There is no maximum.
# @return [Integer]
#
# @!attribute [rw] suppression_unit
# Specifies whether the value of `value` is in seconds, minutes, or
# hours.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/SuppressionPeriod AWS API Documentation
#
class SuppressionPeriod < Struct.new(
:value,
:suppression_unit)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] tags
# The key-value pairs to use for the tags.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TagLogGroupRequest AWS API Documentation
#
class TagLogGroupRequest < Struct.new(
:log_group_name,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] resource_arn
# The ARN of the resource that you're adding tags to.
#
# The ARN format of a log group is
# `arn:aws:logs:Region:account-id:log-group:log-group-name `
#
# The ARN format of a destination is
# `arn:aws:logs:Region:account-id:destination:destination-name `
#
# For more information about ARN format, see [CloudWatch Logs
# resources and operations][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html
# @return [String]
#
# @!attribute [rw] tags
# The list of key-value pairs to associate with the resource.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TagResourceRequest AWS API Documentation
#
class TagResourceRequest < Struct.new(
:resource_arn,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] filter_pattern
# 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.
# @return [String]
#
# @!attribute [rw] log_event_messages
# The log event messages to test.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TestMetricFilterRequest AWS API Documentation
#
class TestMetricFilterRequest < Struct.new(
:filter_pattern,
:log_event_messages)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] matches
# The matched events.
# @return [Array<Types::MetricFilterMatchRecord>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TestMetricFilterResponse AWS API Documentation
#
class TestMetricFilterResponse < Struct.new(
:matches)
SENSITIVE = []
include Aws::Structure
end
# The request was throttled because of quota limits.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ThrottlingException AWS API Documentation
#
class ThrottlingException < Aws::EmptyStructure; end
# A resource can have no more than 50 tags.
#
# @!attribute [rw] message
# @return [String]
#
# @!attribute [rw] resource_name
# The name of the resource.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TooManyTagsException AWS API Documentation
#
class TooManyTagsException < Struct.new(
:message,
:resource_name)
SENSITIVE = []
include Aws::Structure
end
# The most likely cause is an Amazon Web Services access key ID or
# secret key that's not valid.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UnrecognizedClientException AWS API Documentation
#
class UnrecognizedClientException < Aws::EmptyStructure; end
# @!attribute [rw] log_group_name
# The name of the log group.
# @return [String]
#
# @!attribute [rw] tags
# The tag keys. The corresponding tags are removed from the log group.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UntagLogGroupRequest AWS API Documentation
#
class UntagLogGroupRequest < Struct.new(
:log_group_name,
:tags)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] resource_arn
# The ARN of the CloudWatch Logs resource that you're removing tags
# from.
#
# The ARN format of a log group is
# `arn:aws:logs:Region:account-id:log-group:log-group-name `
#
# The ARN format of a destination is
# `arn:aws:logs:Region:account-id:destination:destination-name `
#
# For more information about ARN format, see [CloudWatch Logs
# resources and operations][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html
# @return [String]
#
# @!attribute [rw] tag_keys
# The list of tag keys to remove from the resource.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UntagResourceRequest AWS API Documentation
#
class UntagResourceRequest < Struct.new(
:resource_arn,
:tag_keys)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] anomaly_id
# If you are suppressing or unsuppressing an anomaly, specify its
# unique ID here. You can find anomaly IDs by using the
# [ListAnomalies][1] operation.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html
# @return [String]
#
# @!attribute [rw] pattern_id
# If you are suppressing or unsuppressing an pattern, specify its
# unique ID here. You can find pattern IDs by using the
# [ListAnomalies][1] operation.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html
# @return [String]
#
# @!attribute [rw] anomaly_detector_arn
# The ARN of the anomaly detector that this operation is to act on.
# @return [String]
#
# @!attribute [rw] suppression_type
# Use this to specify whether the suppression to be temporary or
# infinite. If you specify `LIMITED`, you must also specify a
# `suppressionPeriod`. If you specify `INFINITE`, any value for
# `suppressionPeriod` is ignored.
# @return [String]
#
# @!attribute [rw] suppression_period
# If you are temporarily suppressing an anomaly or pattern, use this
# structure to specify how long the suppression is to last.
# @return [Types::SuppressionPeriod]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UpdateAnomalyRequest AWS API Documentation
#
class UpdateAnomalyRequest < Struct.new(
:anomaly_id,
:pattern_id,
:anomaly_detector_arn,
:suppression_type,
:suppression_period)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] anomaly_detector_arn
# The ARN of the anomaly detector that you want to update.
# @return [String]
#
# @!attribute [rw] evaluation_frequency
# Specifies how often the anomaly detector runs and look for
# anomalies. Set this value according to the frequency that the log
# group receives new logs. For example, if the log group receives new
# log events every 10 minutes, then setting `evaluationFrequency` to
# `FIFTEEN_MIN` might be appropriate.
# @return [String]
#
# @!attribute [rw] filter_pattern
# 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.
# @return [String]
#
# @!attribute [rw] anomaly_visibility_time
# The number of days to use as the life cycle of anomalies. After this
# time, anomalies are automatically baselined and the anomaly detector
# model will treat new occurrences of similar event as normal.
# Therefore, if you do not correct the cause of an anomaly during this
# time, it will be considered normal going forward and will not be
# detected.
# @return [Integer]
#
# @!attribute [rw] enabled
# Use this parameter to pause or restart the anomaly detector.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UpdateLogAnomalyDetectorRequest AWS API Documentation
#
class UpdateLogAnomalyDetectorRequest < Struct.new(
:anomaly_detector_arn,
:evaluation_frequency,
:filter_pattern,
:anomaly_visibility_time,
:enabled)
SENSITIVE = []
include Aws::Structure
end
# One of the parameters for the request is not valid.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ValidationException AWS API Documentation
#
class ValidationException < Aws::EmptyStructure; end
# This object includes the stream returned by your [StartLiveTail][1]
# request.
#
#
#
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTail.html
#
# EventStream is an Enumerator of Events.
# #event_types #=> Array, returns all modeled event types in the stream
#
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartLiveTailResponseStream AWS API Documentation
#
class StartLiveTailResponseStream < Enumerator
def event_types
[
:session_start,
:session_update,
:session_timeout_exception,
:session_streaming_exception
]
end
end
end
end