Class: Aws::CloudWatchLogs::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb

Overview

An API client for CloudWatchLogs. To construct a client, you need to configure a :region and :credentials.

client = Aws::CloudWatchLogs::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CloudWatchLogs::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CloudWatchLogs::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



395
396
397
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 395

def initialize(*args)
  super
end

Instance Method Details

#associate_kms_key(params = {}) ⇒ Struct

Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.

When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

  • Specify the logGroupName parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.

    Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

    Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier parameter that specifies a query-result resource.

  • Specify the resourceIdentifier parameter with a query-result resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.

    Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.

    If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.

If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.

CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.

It can take up to 5 minutes for this operation to take effect.

If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

Examples:

Request syntax with placeholder values


resp = client.associate_kms_key({
  log_group_name: "LogGroupName",
  kms_key_id: "KmsKeyId", # required
  resource_identifier: "ResourceIdentifier",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (String) —

    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.

  • :kms_key_id (required, String) —

    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 and Using Symmetric and Asymmetric Keys.

  • :resource_identifier (String) —

    Specifies the target for this operation. You must specify one of the following:

    • Specify the following ARN to have future GetQueryResults 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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



522
523
524
525
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 522

def associate_kms_key(params = {}, options = {})
  req = build_request(:associate_kms_key, params)
  req.send_request(options)
end

#cancel_export_task(params = {}) ⇒ Struct

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

Examples:

Request syntax with placeholder values


resp = client.cancel_export_task({
  task_id: "ExportTaskId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_id (required, String) —

    The ID of the export task.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



546
547
548
549
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 546

def cancel_export_task(params = {}, options = {})
  req = build_request(:cancel_export_task, params)
  req.send_request(options)
end

#create_delivery(params = {}) ⇒ Types::CreateDeliveryResponse

Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.

Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Kinesis Data Firehose.

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.

  • Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.

  • If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

  • Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination.

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.

You can't update an existing delivery. You can only create and delete deliveries.

Examples:

Request syntax with placeholder values


resp = client.create_delivery({
  delivery_source_name: "DeliverySourceName", # required
  delivery_destination_arn: "Arn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.delivery.id #=> String
resp.delivery.arn #=> String
resp.delivery.delivery_source_name #=> String
resp.delivery.delivery_destination_arn #=> String
resp.delivery.delivery_destination_type #=> String, one of "S3", "CWL", "FH"
resp.delivery.tags #=> Hash
resp.delivery.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delivery_source_name (required, String) —

    The name of the delivery source to use for this delivery.

  • :delivery_destination_arn (required, String) —

    The ARN of the delivery destination to use for this delivery.

  • :tags (Hash<String,String>) —

    An optional list of key-value pairs to associate with the resource.

    For more information about tagging, see Tagging Amazon Web Services resources

Returns:

See Also:



641
642
643
644
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 641

def create_delivery(params = {}, options = {})
  req = build_request(:create_delivery, params)
  req.send_request(options)
end

#create_export_task(params = {}) ⇒ Types::CreateExportTaskResponse

Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.

Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.

Exporting to S3 buckets that are encrypted with AES-256 is supported.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.

Examples:

Request syntax with placeholder values


resp = client.create_export_task({
  task_name: "ExportTaskName",
  log_group_name: "LogGroupName", # required
  log_stream_name_prefix: "LogStreamName",
  from: 1, # required
  to: 1, # required
  destination: "ExportDestinationBucket", # required
  destination_prefix: "ExportDestinationPrefix",
})

Response structure


resp.task_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_name (String) —

    The name of the export task.

  • :log_group_name (required, String) —

    The name of the log group.

  • :log_stream_name_prefix (String) —

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

  • :from (required, Integer) —

    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.

  • :to (required, Integer) —

    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.

  • :destination (required, String) —

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

  • :destination_prefix (String) —

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

Returns:

See Also:



736
737
738
739
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 736

def create_export_task(params = {}, options = {})
  req = build_request(:create_export_task, params)
  req.send_request(options)
end

#create_log_anomaly_detector(params = {}) ⇒ Types::CreateLogAnomalyDetectorResponse

Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.

An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.

The anomaly detector uses pattern recognition to find anomalies, which are unusual log events. It uses the evaluationFrequency to compare current log events and patterns with trained baselines.

Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or timestamp, are referred to as dynamic tokens and represented by <*>.

The following is an example of a pattern:

[INFO] Request time: <*> ms

This pattern represents log events like [INFO] Request time: 327 ms and other similar log events that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced by <*>

Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see Help protect sensitive log data with masking.

Examples:

Request syntax with placeholder values


resp = client.create_log_anomaly_detector({
  log_group_arn_list: ["LogGroupArn"], # required
  detector_name: "DetectorName",
  evaluation_frequency: "ONE_MIN", # accepts ONE_MIN, FIVE_MIN, TEN_MIN, FIFTEEN_MIN, THIRTY_MIN, ONE_HOUR
  filter_pattern: "FilterPattern",
  kms_key_id: "KmsKeyId",
  anomaly_visibility_time: 1,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.anomaly_detector_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_arn_list (required, Array<String>) —

    An array containing the ARNs of the log groups that this anomaly detector will watch. You must specify at least one ARN.

  • :detector_name (String) —

    A name for this anomaly detector.

  • :evaluation_frequency (String) —

    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 .

  • :filter_pattern (String) —

    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.

  • :kms_key_id (String) —

    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.

  • :anomaly_visibility_time (Integer) —

    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.

  • :tags (Hash<String,String>) —

    An optional list of key-value pairs to associate with the resource.

    For more information about tagging, see Tagging Amazon Web Services resources

Returns:

See Also:



862
863
864
865
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 862

def create_log_anomaly_detector(params = {}, options = {})
  req = build_request(:create_log_anomaly_detector, params)
  req.send_request(options)
end

#create_log_group(params = {}) ⇒ Struct

Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a Region for an Amazon Web Services account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign)

When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.

Examples:

Request syntax with placeholder values


resp = client.create_log_group({
  log_group_name: "LogGroupName", # required
  kms_key_id: "KmsKeyId",
  tags: {
    "TagKey" => "TagValue",
  },
  log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    A name for the log group.

  • :kms_key_id (String) —

    The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.

  • :tags (Hash<String,String>) —

    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. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

  • :log_group_class (String) —

    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.

    For details about the features supported by each class, see Log classes

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



966
967
968
969
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 966

def create_log_group(params = {}, options = {})
  req = build_request(:create_log_group, params)
  req.send_request(options)
end

#create_log_stream(params = {}) ⇒ Struct

Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.

There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • Don't use ':' (colon) or '*' (asterisk) characters.

Examples:

Request syntax with placeholder values


resp = client.create_log_stream({
  log_group_name: "LogGroupName", # required
  log_stream_name: "LogStreamName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :log_stream_name (required, String) —

    The name of the log stream.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1006
1007
1008
1009
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1006

def create_log_stream(params = {}, options = {})
  req = build_request(:create_log_stream, params)
  req.send_request(options)
end

#delete_account_policy(params = {}) ⇒ Struct

Deletes a CloudWatch Logs account policy.

To use this operation, you must be signed on with the logs:DeleteDataProtectionPolicy and logs:DeleteAccountPolicy permissions.

Examples:

Request syntax with placeholder values


resp = client.({
  policy_name: "PolicyName", # required
  policy_type: "DATA_PROTECTION_POLICY", # required, accepts DATA_PROTECTION_POLICY
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_name (required, String) —

    The name of the policy to delete.

  • :policy_type (required, String) —

    The type of policy to delete. Currently, the only valid value is DATA_PROTECTION_POLICY.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1037
1038
1039
1040
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1037

def (params = {}, options = {})
  req = build_request(:delete_account_policy, params)
  req.send_request(options)
end

#delete_data_protection_policy(params = {}) ⇒ Struct

Deletes the data protection policy from the specified log group.

For more information about data protection policies, see PutDataProtectionPolicy.

Examples:

Request syntax with placeholder values


resp = client.delete_data_protection_policy({
  log_group_identifier: "LogGroupIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_identifier (required, String) —

    The name or ARN of the log group that you want to delete the data protection policy for.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1067
1068
1069
1070
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1067

def delete_data_protection_policy(params = {}, options = {})
  req = build_request(:delete_data_protection_policy, params)
  req.send_request(options)
end

#delete_delivery(params = {}) ⇒ Struct

Deletes s delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.

Examples:

Request syntax with placeholder values


resp = client.delete_delivery({
  id: "DeliveryId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The unique ID of the delivery to delete. You can find the ID of a delivery with the DescribeDeliveries operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1098
1099
1100
1101
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1098

def delete_delivery(params = {}, options = {})
  req = build_request(:delete_delivery, params)
  req.send_request(options)
end

#delete_delivery_destination(params = {}) ⇒ Struct

Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.

You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results.

Examples:

Request syntax with placeholder values


resp = client.delete_delivery_destination({
  name: "DeliveryDestinationName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the delivery destination that you want to delete. You can find a list of delivery destionation names by using the DescribeDeliveryDestinations operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1136
1137
1138
1139
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1136

def delete_delivery_destination(params = {}, options = {})
  req = build_request(:delete_delivery_destination, params)
  req.send_request(options)
end

#delete_delivery_destination_policy(params = {}) ⇒ Struct

Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.

Examples:

Request syntax with placeholder values


resp = client.delete_delivery_destination_policy({
  delivery_destination_name: "DeliveryDestinationName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delivery_destination_name (required, String) —

    The name of the delivery destination that you want to delete the policy for.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1164
1165
1166
1167
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1164

def delete_delivery_destination_policy(params = {}, options = {})
  req = build_request(:delete_delivery_destination_policy, params)
  req.send_request(options)
end

#delete_delivery_source(params = {}) ⇒ Struct

Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.

You can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the deliverySourceName field in the results.

Examples:

Request syntax with placeholder values


resp = client.delete_delivery_source({
  name: "DeliverySourceName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the delivery source that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1196
1197
1198
1199
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1196

def delete_delivery_source(params = {}, options = {})
  req = build_request(:delete_delivery_source, params)
  req.send_request(options)
end

#delete_destination(params = {}) ⇒ Struct

Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.

Examples:

Request syntax with placeholder values


resp = client.delete_destination({
  destination_name: "DestinationName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_name (required, String) —

    The name of the destination.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1220
1221
1222
1223
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1220

def delete_destination(params = {}, options = {})
  req = build_request(:delete_destination, params)
  req.send_request(options)
end

#delete_log_anomaly_detector(params = {}) ⇒ Struct

Deletes the specified CloudWatch Logs anomaly detector.

Examples:

Request syntax with placeholder values


resp = client.delete_log_anomaly_detector({
  anomaly_detector_arn: "AnomalyDetectorArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :anomaly_detector_arn (required, String) —

    The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly detectors in your account by using the ListLogAnomalyDetectors operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1248
1249
1250
1251
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1248

def delete_log_anomaly_detector(params = {}, options = {})
  req = build_request(:delete_log_anomaly_detector, params)
  req.send_request(options)
end

#delete_log_group(params = {}) ⇒ Struct

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

Examples:

Request syntax with placeholder values


resp = client.delete_log_group({
  log_group_name: "LogGroupName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1271
1272
1273
1274
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1271

def delete_log_group(params = {}, options = {})
  req = build_request(:delete_log_group, params)
  req.send_request(options)
end

#delete_log_stream(params = {}) ⇒ Struct

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

Examples:

Request syntax with placeholder values


resp = client.delete_log_stream({
  log_group_name: "LogGroupName", # required
  log_stream_name: "LogStreamName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :log_stream_name (required, String) —

    The name of the log stream.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1298
1299
1300
1301
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1298

def delete_log_stream(params = {}, options = {})
  req = build_request(:delete_log_stream, params)
  req.send_request(options)
end

#delete_metric_filter(params = {}) ⇒ Struct

Deletes the specified metric filter.

Examples:

Request syntax with placeholder values


resp = client.delete_metric_filter({
  log_group_name: "LogGroupName", # required
  filter_name: "FilterName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :filter_name (required, String) —

    The name of the metric filter.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1324
1325
1326
1327
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1324

def delete_metric_filter(params = {}, options = {})
  req = build_request(:delete_metric_filter, params)
  req.send_request(options)
end

#delete_query_definition(params = {}) ⇒ Types::DeleteQueryDefinitionResponse

Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.

Each DeleteQueryDefinition operation can delete one query definition.

You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.

Examples:

Request syntax with placeholder values


resp = client.delete_query_definition({
  query_definition_id: "QueryId", # required
})

Response structure


resp.success #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :query_definition_id (required, String) —

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

Returns:

See Also:



1366
1367
1368
1369
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1366

def delete_query_definition(params = {}, options = {})
  req = build_request(:delete_query_definition, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ Struct

Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  policy_name: "PolicyName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_name (String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1389
1390
1391
1392
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1389

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#delete_retention_policy(params = {}) ⇒ Struct

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

Examples:

Request syntax with placeholder values


resp = client.delete_retention_policy({
  log_group_name: "LogGroupName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1414
1415
1416
1417
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1414

def delete_retention_policy(params = {}, options = {})
  req = build_request(:delete_retention_policy, params)
  req.send_request(options)
end

#delete_subscription_filter(params = {}) ⇒ Struct

Deletes the specified subscription filter.

Examples:

Request syntax with placeholder values


resp = client.delete_subscription_filter({
  log_group_name: "LogGroupName", # required
  filter_name: "FilterName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :filter_name (required, String) —

    The name of the subscription filter.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1440
1441
1442
1443
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1440

def delete_subscription_filter(params = {}, options = {})
  req = build_request(:delete_subscription_filter, params)
  req.send_request(options)
end

#describe_account_policies(params = {}) ⇒ Types::DescribeAccountPoliciesResponse

Returns a list of all CloudWatch Logs account policies in the account.

Examples:

Request syntax with placeholder values


resp = client.({
  policy_type: "DATA_PROTECTION_POLICY", # required, accepts DATA_PROTECTION_POLICY
  policy_name: "PolicyName",
  account_identifiers: ["AccountId"],
})

Response structure


resp. #=> Array
resp.[0].policy_name #=> String
resp.[0].policy_document #=> String
resp.[0].last_updated_time #=> Integer
resp.[0].policy_type #=> String, one of "DATA_PROTECTION_POLICY"
resp.[0].scope #=> String, one of "ALL"
resp.[0]. #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_type (required, String) —

    Use this parameter to limit the returned policies to only the policies that match the policy type that you specify. Currently, the only valid value is DATA_PROTECTION_POLICY.

  • :policy_name (String) —

    Use this parameter to limit the returned policies to only the policy with the name that you specify.

  • :account_identifiers (Array<String>) —

    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.

Returns:

See Also:



1492
1493
1494
1495
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1492

def (params = {}, options = {})
  req = build_request(:describe_account_policies, params)
  req.send_request(options)
end

#describe_deliveries(params = {}) ⇒ Types::DescribeDeliveriesResponse

Retrieves a list of the deliveries that have been created in the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_deliveries({
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.deliveries #=> Array
resp.deliveries[0].id #=> String
resp.deliveries[0].arn #=> String
resp.deliveries[0].delivery_source_name #=> String
resp.deliveries[0].delivery_destination_arn #=> String
resp.deliveries[0].delivery_destination_type #=> String, one of "S3", "CWL", "FH"
resp.deliveries[0].tags #=> Hash
resp.deliveries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. The token expires after 24 hours.

  • :limit (Integer) —

    Optionally specify the maximum number of deliveries to return in the response.

Returns:

See Also:



1538
1539
1540
1541
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1538

def describe_deliveries(params = {}, options = {})
  req = build_request(:describe_deliveries, params)
  req.send_request(options)
end

#describe_delivery_destinations(params = {}) ⇒ Types::DescribeDeliveryDestinationsResponse

Retrieves a list of the delivery destinations that have been created in the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_delivery_destinations({
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.delivery_destinations #=> Array
resp.delivery_destinations[0].name #=> String
resp.delivery_destinations[0].arn #=> String
resp.delivery_destinations[0].delivery_destination_type #=> String, one of "S3", "CWL", "FH"
resp.delivery_destinations[0].output_format #=> String, one of "json", "plain", "w3c", "raw", "parquet"
resp.delivery_destinations[0].delivery_destination_configuration.destination_resource_arn #=> String
resp.delivery_destinations[0].tags #=> Hash
resp.delivery_destinations[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. The token expires after 24 hours.

  • :limit (Integer) —

    Optionally specify the maximum number of delivery destinations to return in the response.

Returns:

See Also:



1584
1585
1586
1587
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1584

def describe_delivery_destinations(params = {}, options = {})
  req = build_request(:describe_delivery_destinations, params)
  req.send_request(options)
end

#describe_delivery_sources(params = {}) ⇒ Types::DescribeDeliverySourcesResponse

Retrieves a list of the delivery sources that have been created in the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_delivery_sources({
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.delivery_sources #=> Array
resp.delivery_sources[0].name #=> String
resp.delivery_sources[0].arn #=> String
resp.delivery_sources[0].resource_arns #=> Array
resp.delivery_sources[0].resource_arns[0] #=> String
resp.delivery_sources[0].service #=> String
resp.delivery_sources[0].log_type #=> String
resp.delivery_sources[0].tags #=> Hash
resp.delivery_sources[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. The token expires after 24 hours.

  • :limit (Integer) —

    Optionally specify the maximum number of delivery sources to return in the response.

Returns:

See Also:



1631
1632
1633
1634
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1631

def describe_delivery_sources(params = {}, options = {})
  req = build_request(:describe_delivery_sources, params)
  req.send_request(options)
end

#describe_destinations(params = {}) ⇒ Types::DescribeDestinationsResponse

Lists all your destinations. The results are ASCII-sorted by destination name.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_destinations({
  destination_name_prefix: "DestinationName",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.destinations #=> Array
resp.destinations[0].destination_name #=> String
resp.destinations[0].target_arn #=> String
resp.destinations[0].role_arn #=> String
resp.destinations[0].access_policy #=> String
resp.destinations[0].arn #=> String
resp.destinations[0].creation_time #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_name_prefix (String) —

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

  • :next_token (String) —

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

  • :limit (Integer) —

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

Returns:

See Also:



1681
1682
1683
1684
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1681

def describe_destinations(params = {}, options = {})
  req = build_request(:describe_destinations, params)
  req.send_request(options)
end

#describe_export_tasks(params = {}) ⇒ Types::DescribeExportTasksResponse

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

Examples:

Request syntax with placeholder values


resp = client.describe_export_tasks({
  task_id: "ExportTaskId",
  status_code: "CANCELLED", # accepts CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.export_tasks #=> Array
resp.export_tasks[0].task_id #=> String
resp.export_tasks[0].task_name #=> String
resp.export_tasks[0].log_group_name #=> String
resp.export_tasks[0].from #=> Integer
resp.export_tasks[0].to #=> Integer
resp.export_tasks[0].destination #=> String
resp.export_tasks[0].destination_prefix #=> String
resp.export_tasks[0].status.code #=> String, one of "CANCELLED", "COMPLETED", "FAILED", "PENDING", "PENDING_CANCEL", "RUNNING"
resp.export_tasks[0].status.message #=> String
resp.export_tasks[0].execution_info.creation_time #=> Integer
resp.export_tasks[0].execution_info.completion_time #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_id (String) —

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

  • :status_code (String) —

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

  • :next_token (String) —

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

  • :limit (Integer) —

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

Returns:

See Also:



1739
1740
1741
1742
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1739

def describe_export_tasks(params = {}, options = {})
  req = build_request(:describe_export_tasks, params)
  req.send_request(options)
end

#describe_log_groups(params = {}) ⇒ Types::DescribeLogGroupsResponse

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_log_groups({
  account_identifiers: ["AccountId"],
  log_group_name_prefix: "LogGroupName",
  log_group_name_pattern: "LogGroupNamePattern",
  next_token: "NextToken",
  limit: 1,
  include_linked_accounts: false,
  log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS
})

Response structure


resp.log_groups #=> Array
resp.log_groups[0].log_group_name #=> String
resp.log_groups[0].creation_time #=> Integer
resp.log_groups[0].retention_in_days #=> Integer
resp.log_groups[0].metric_filter_count #=> Integer
resp.log_groups[0].arn #=> String
resp.log_groups[0].stored_bytes #=> Integer
resp.log_groups[0].kms_key_id #=> String
resp.log_groups[0].data_protection_status #=> String, one of "ACTIVATED", "DELETED", "ARCHIVED", "DISABLED"
resp.log_groups[0].inherited_properties #=> Array
resp.log_groups[0].inherited_properties[0] #=> String, one of "ACCOUNT_DATA_PROTECTION"
resp.log_groups[0].log_group_class #=> String, one of "STANDARD", "INFREQUENT_ACCESS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_identifiers (Array<String>) —

    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.

  • :log_group_name_prefix (String) —

    The prefix to match.

    logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

  • :log_group_name_pattern (String) —

    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.

    logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

  • :next_token (String) —

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

  • :limit (Integer) —

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

  • :include_linked_accounts (Boolean) —

    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.

  • :log_group_class (String) —

    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

Returns:

See Also:



1866
1867
1868
1869
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1866

def describe_log_groups(params = {}, options = {})
  req = build_request(:describe_log_groups, params)
  req.send_request(options)
end

#describe_log_streams(params = {}) ⇒ Types::DescribeLogStreamsResponse

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

This operation has a limit of five transactions per second, after which transactions are throttled.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_log_streams({
  log_group_name: "LogGroupName",
  log_group_identifier: "LogGroupIdentifier",
  log_stream_name_prefix: "LogStreamName",
  order_by: "LogStreamName", # accepts LogStreamName, LastEventTime
  descending: false,
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.log_streams #=> Array
resp.log_streams[0].log_stream_name #=> String
resp.log_streams[0].creation_time #=> Integer
resp.log_streams[0].first_event_timestamp #=> Integer
resp.log_streams[0].last_event_timestamp #=> Integer
resp.log_streams[0].last_ingestion_time #=> Integer
resp.log_streams[0].upload_sequence_token #=> String
resp.log_streams[0].arn #=> String
resp.log_streams[0].stored_bytes #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (String) —

    The name of the log group.

    You must include either logGroupIdentifier or logGroupName, but not both.

  • :log_group_identifier (String) —

    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.

    You must include either logGroupIdentifier or logGroupName, but not both.

  • :log_stream_name_prefix (String) —

    The prefix to match.

    If orderBy is LastEventTime, you cannot specify this parameter.

  • :order_by (String) —

    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.

  • :descending (Boolean) —

    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.

  • :next_token (String) —

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

  • :limit (Integer) —

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

Returns:

See Also:



1978
1979
1980
1981
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1978

def describe_log_streams(params = {}, options = {})
  req = build_request(:describe_log_streams, params)
  req.send_request(options)
end

#describe_metric_filters(params = {}) ⇒ Types::DescribeMetricFiltersResponse

Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_metric_filters({
  log_group_name: "LogGroupName",
  filter_name_prefix: "FilterName",
  next_token: "NextToken",
  limit: 1,
  metric_name: "MetricName",
  metric_namespace: "MetricNamespace",
})

Response structure


resp.metric_filters #=> Array
resp.metric_filters[0].filter_name #=> String
resp.metric_filters[0].filter_pattern #=> String
resp.metric_filters[0].metric_transformations #=> Array
resp.metric_filters[0].metric_transformations[0].metric_name #=> String
resp.metric_filters[0].metric_transformations[0].metric_namespace #=> String
resp.metric_filters[0].metric_transformations[0].metric_value #=> String
resp.metric_filters[0].metric_transformations[0].default_value #=> Float
resp.metric_filters[0].metric_transformations[0].dimensions #=> Hash
resp.metric_filters[0].metric_transformations[0].dimensions["DimensionsKey"] #=> String
resp.metric_filters[0].metric_transformations[0].unit #=> String, one of "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.metric_filters[0].creation_time #=> Integer
resp.metric_filters[0].log_group_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (String) —

    The name of the log group.

  • :filter_name_prefix (String) —

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

  • :next_token (String) —

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

  • :limit (Integer) —

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

  • :metric_name (String) —

    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.

  • :metric_namespace (String) —

    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.

Returns:

See Also:



2051
2052
2053
2054
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2051

def describe_metric_filters(params = {}, options = {})
  req = build_request(:describe_metric_filters, params)
  req.send_request(options)
end

#describe_queries(params = {}) ⇒ Types::DescribeQueriesResponse

Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.

Examples:

Request syntax with placeholder values


resp = client.describe_queries({
  log_group_name: "LogGroupName",
  status: "Scheduled", # accepts Scheduled, Running, Complete, Failed, Cancelled, Timeout, Unknown
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.queries #=> Array
resp.queries[0].query_id #=> String
resp.queries[0].query_string #=> String
resp.queries[0].status #=> String, one of "Scheduled", "Running", "Complete", "Failed", "Cancelled", "Timeout", "Unknown"
resp.queries[0].create_time #=> Integer
resp.queries[0].log_group_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (String) —

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

  • :status (String) —

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

  • :max_results (Integer) —

    Limits the number of returned queries to the specified number.

  • :next_token (String) —

    The token for the next set of items to return. The token expires after 24 hours.

Returns:

See Also:



2104
2105
2106
2107
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2104

def describe_queries(params = {}, options = {})
  req = build_request(:describe_queries, params)
  req.send_request(options)
end

#describe_query_definitions(params = {}) ⇒ Types::DescribeQueryDefinitionsResponse

This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.

You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.

Examples:

Request syntax with placeholder values


resp = client.describe_query_definitions({
  query_definition_name_prefix: "QueryDefinitionName",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.query_definitions #=> Array
resp.query_definitions[0].query_definition_id #=> String
resp.query_definitions[0].name #=> String
resp.query_definitions[0].query_string #=> String
resp.query_definitions[0].last_modified #=> Integer
resp.query_definitions[0].log_group_names #=> Array
resp.query_definitions[0].log_group_names[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :query_definition_name_prefix (String) —

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

  • :max_results (Integer) —

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

  • :next_token (String) —

    The token for the next set of items to return. The token expires after 24 hours.

Returns:

See Also:



2156
2157
2158
2159
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2156

def describe_query_definitions(params = {}, options = {})
  req = build_request(:describe_query_definitions, params)
  req.send_request(options)
end

#describe_resource_policies(params = {}) ⇒ Types::DescribeResourcePoliciesResponse

Lists the resource policies in this account.

Examples:

Request syntax with placeholder values


resp = client.describe_resource_policies({
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.resource_policies #=> Array
resp.resource_policies[0].policy_name #=> String
resp.resource_policies[0].policy_document #=> String
resp.resource_policies[0].last_updated_time #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. The token expires after 24 hours.

  • :limit (Integer) —

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

Returns:

See Also:



2195
2196
2197
2198
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2195

def describe_resource_policies(params = {}, options = {})
  req = build_request(:describe_resource_policies, params)
  req.send_request(options)
end

#describe_subscription_filters(params = {}) ⇒ Types::DescribeSubscriptionFiltersResponse

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_subscription_filters({
  log_group_name: "LogGroupName", # required
  filter_name_prefix: "FilterName",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.subscription_filters #=> Array
resp.subscription_filters[0].filter_name #=> String
resp.subscription_filters[0].log_group_name #=> String
resp.subscription_filters[0].filter_pattern #=> String
resp.subscription_filters[0].destination_arn #=> String
resp.subscription_filters[0].role_arn #=> String
resp.subscription_filters[0].distribution #=> String, one of "Random", "ByLogStream"
resp.subscription_filters[0].creation_time #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :filter_name_prefix (String) —

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

  • :next_token (String) —

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

  • :limit (Integer) —

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

Returns:

See Also:



2251
2252
2253
2254
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2251

def describe_subscription_filters(params = {}, options = {})
  req = build_request(:describe_subscription_filters, params)
  req.send_request(options)
end

#disassociate_kms_key(params = {}) ⇒ Struct

Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.

When you use DisassociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.

  • Specify the logGroupName parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

  • Specify the resourceIdentifier parameter with the query-result resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.

It can take up to 5 minutes for this operation to take effect.

Examples:

Request syntax with placeholder values


resp = client.disassociate_kms_key({
  log_group_name: "LogGroupName",
  resource_identifier: "ResourceIdentifier",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (String) —

    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.

  • :resource_identifier (String) —

    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 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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2332
2333
2334
2335
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2332

def disassociate_kms_key(params = {}, options = {})
  req = build_request(:disassociate_kms_key, params)
  req.send_request(options)
end

#filter_log_events(params = {}) ⇒ Types::FilterLogEventsResponse

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

You must have the logs:FilterLogEvents permission to perform this operation.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.filter_log_events({
  log_group_name: "LogGroupName",
  log_group_identifier: "LogGroupIdentifier",
  log_stream_names: ["LogStreamName"],
  log_stream_name_prefix: "LogStreamName",
  start_time: 1,
  end_time: 1,
  filter_pattern: "FilterPattern",
  next_token: "NextToken",
  limit: 1,
  interleaved: false,
  unmask: false,
})

Response structure


resp.events #=> Array
resp.events[0].log_stream_name #=> String
resp.events[0].timestamp #=> Integer
resp.events[0].message #=> String
resp.events[0].ingestion_time #=> Integer
resp.events[0].event_id #=> String
resp.searched_log_streams #=> Array
resp.searched_log_streams[0].log_stream_name #=> String
resp.searched_log_streams[0].searched_completely #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (String) —

    The name of the log group to search.

    You must include either logGroupIdentifier or logGroupName, but not both.

  • :log_group_identifier (String) —

    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.

    You must include either logGroupIdentifier or logGroupName, but not both.

  • :log_stream_names (Array<String>) —

    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.

  • :log_stream_name_prefix (String) —

    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.

  • :start_time (Integer) —

    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.

  • :end_time (Integer) —

    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.

  • :filter_pattern (String) —

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

    If not provided, all the events are matched.

  • :next_token (String) —

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

  • :limit (Integer) —

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

  • :interleaved (Boolean) —

    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.

  • :unmask (Boolean) —

    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.

Returns:

See Also:



2489
2490
2491
2492
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2489

def filter_log_events(params = {}, options = {})
  req = build_request(:filter_log_events, params)
  req.send_request(options)
end

#get_data_protection_policy(params = {}) ⇒ Types::GetDataProtectionPolicyResponse

Returns information about a log group data protection policy.

Examples:

Request syntax with placeholder values


resp = client.get_data_protection_policy({
  log_group_identifier: "LogGroupIdentifier", # required
})

Response structure


resp.log_group_identifier #=> String
resp.policy_document #=> String
resp.last_updated_time #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_identifier (required, String) —

    The name or ARN of the log group that contains the data protection policy that you want to see.

Returns:

See Also:



2522
2523
2524
2525
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2522

def get_data_protection_policy(params = {}, options = {})
  req = build_request(:get_data_protection_policy, params)
  req.send_request(options)
end

#get_delivery(params = {}) ⇒ Types::GetDeliveryResponse

Returns complete information about one delivery. A delivery is a connection between a logical delivery source and a logical delivery destination

You need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.

Examples:

Request syntax with placeholder values


resp = client.get_delivery({
  id: "DeliveryId", # required
})

Response structure


resp.delivery.id #=> String
resp.delivery.arn #=> String
resp.delivery.delivery_source_name #=> String
resp.delivery.delivery_destination_arn #=> String
resp.delivery.delivery_destination_type #=> String, one of "S3", "CWL", "FH"
resp.delivery.tags #=> Hash
resp.delivery.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the delivery that you want to retrieve.

Returns:

See Also:



2566
2567
2568
2569
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2566

def get_delivery(params = {}, options = {})
  req = build_request(:get_delivery, params)
  req.send_request(options)
end

#get_delivery_destination(params = {}) ⇒ Types::GetDeliveryDestinationResponse

Retrieves complete information about one delivery destination.

Examples:

Request syntax with placeholder values


resp = client.get_delivery_destination({
  name: "DeliveryDestinationName", # required
})

Response structure


resp.delivery_destination.name #=> String
resp.delivery_destination.arn #=> String
resp.delivery_destination.delivery_destination_type #=> String, one of "S3", "CWL", "FH"
resp.delivery_destination.output_format #=> String, one of "json", "plain", "w3c", "raw", "parquet"
resp.delivery_destination.delivery_destination_configuration.destination_resource_arn #=> String
resp.delivery_destination.tags #=> Hash
resp.delivery_destination.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the delivery destination that you want to retrieve.

Returns:

See Also:



2600
2601
2602
2603
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2600

def get_delivery_destination(params = {}, options = {})
  req = build_request(:get_delivery_destination, params)
  req.send_request(options)
end

#get_delivery_destination_policy(params = {}) ⇒ Types::GetDeliveryDestinationPolicyResponse

Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.

Examples:

Request syntax with placeholder values


resp = client.get_delivery_destination_policy({
  delivery_destination_name: "DeliveryDestinationName", # required
})

Response structure


resp.policy.delivery_destination_policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delivery_destination_name (required, String) —

    The name of the delivery destination that you want to retrieve the policy of.

Returns:

See Also:



2636
2637
2638
2639
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2636

def get_delivery_destination_policy(params = {}, options = {})
  req = build_request(:get_delivery_destination_policy, params)
  req.send_request(options)
end

#get_delivery_source(params = {}) ⇒ Types::GetDeliverySourceResponse

Retrieves complete information about one delivery source.

Examples:

Request syntax with placeholder values


resp = client.get_delivery_source({
  name: "DeliverySourceName", # required
})

Response structure


resp.delivery_source.name #=> String
resp.delivery_source.arn #=> String
resp.delivery_source.resource_arns #=> Array
resp.delivery_source.resource_arns[0] #=> String
resp.delivery_source.service #=> String
resp.delivery_source.log_type #=> String
resp.delivery_source.tags #=> Hash
resp.delivery_source.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the delivery source that you want to retrieve.

Returns:

See Also:



2671
2672
2673
2674
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2671

def get_delivery_source(params = {}, options = {})
  req = build_request(:get_delivery_source, params)
  req.send_request(options)
end

#get_log_anomaly_detector(params = {}) ⇒ Types::GetLogAnomalyDetectorResponse

Retrieves information about the log anomaly detector that you specify.

Examples:

Request syntax with placeholder values


resp = client.get_log_anomaly_detector({
  anomaly_detector_arn: "AnomalyDetectorArn", # required
})

Response structure


resp.detector_name #=> String
resp.log_group_arn_list #=> Array
resp.log_group_arn_list[0] #=> String
resp.evaluation_frequency #=> String, one of "ONE_MIN", "FIVE_MIN", "TEN_MIN", "FIFTEEN_MIN", "THIRTY_MIN", "ONE_HOUR"
resp.filter_pattern #=> String
resp.anomaly_detector_status #=> String, one of "INITIALIZING", "TRAINING", "ANALYZING", "FAILED", "DELETED", "PAUSED"
resp.kms_key_id #=> String
resp.creation_time_stamp #=> Integer
resp.last_modified_time_stamp #=> Integer
resp.anomaly_visibility_time #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :anomaly_detector_arn (required, String) —

    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 operation.

Returns:

See Also:



2722
2723
2724
2725
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2722

def get_log_anomaly_detector(params = {}, options = {})
  req = build_request(:get_log_anomaly_detector, params)
  req.send_request(options)
end

#get_log_events(params = {}) ⇒ Types::GetLogEventsResponse

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_log_events({
  log_group_name: "LogGroupName",
  log_group_identifier: "LogGroupIdentifier",
  log_stream_name: "LogStreamName", # required
  start_time: 1,
  end_time: 1,
  next_token: "NextToken",
  limit: 1,
  start_from_head: false,
  unmask: false,
})

Response structure


resp.events #=> Array
resp.events[0].timestamp #=> Integer
resp.events[0].message #=> String
resp.events[0].ingestion_time #=> Integer
resp.next_forward_token #=> String
resp.next_backward_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (String) —

    The name of the log group.

    You must include either logGroupIdentifier or logGroupName, but not both.

  • :log_group_identifier (String) —

    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.

    You must include either logGroupIdentifier or logGroupName, but not both.

  • :log_stream_name (required, String) —

    The name of the log stream.

  • :start_time (Integer) —

    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.

  • :end_time (Integer) —

    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.

  • :next_token (String) —

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

  • :limit (Integer) —

    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).

  • :start_from_head (Boolean) —

    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.

  • :unmask (Boolean) —

    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.

Returns:

See Also:



2841
2842
2843
2844
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2841

def get_log_events(params = {}, options = {})
  req = build_request(:get_log_events, params)
  req.send_request(options)
end

#get_log_group_fields(params = {}) ⇒ Types::GetLogGroupFieldsResponse

Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can't specify both.

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

The response results are sorted by the frequency percentage, starting with the highest percentage.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

Examples:

Request syntax with placeholder values


resp = client.get_log_group_fields({
  log_group_name: "LogGroupName",
  time: 1,
  log_group_identifier: "LogGroupIdentifier",
})

Response structure


resp.log_group_fields #=> Array
resp.log_group_fields[0].name #=> String
resp.log_group_fields[0].percent #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (String) —

    The name of the log group to search.

    You must include either logGroupIdentifier or logGroupName, but not both.

  • :time (Integer) —

    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.

  • :log_group_identifier (String) —

    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.

    You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

See Also:



2922
2923
2924
2925
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2922

def get_log_group_fields(params = {}, options = {})
  req = build_request(:get_log_group_fields, params)
  req.send_request(options)
end

#get_log_record(params = {}) ⇒ Types::GetLogRecordResponse

Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

The full unparsed log event is returned within @message.

Examples:

Request syntax with placeholder values


resp = client.get_log_record({
  log_record_pointer: "LogRecordPointer", # required
  unmask: false,
})

Response structure


resp.log_record #=> Hash
resp.log_record["Field"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_record_pointer (required, String) —

    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.

  • :unmask (Boolean) —

    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.

Returns:

See Also:



2968
2969
2970
2971
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2968

def get_log_record(params = {}, options = {})
  req = build_request(:get_log_record, params)
  req.send_request(options)
end

#get_query_results(params = {}) ⇒ Types::GetQueryResultsResponse

Returns the results from the specified query.

Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.

GetQueryResults does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries are available, see CloudWatch Logs quotas.

If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.

Examples:

Request syntax with placeholder values


resp = client.get_query_results({
  query_id: "QueryId", # required
})

Response structure


resp.results #=> Array
resp.results[0] #=> Array
resp.results[0][0].field #=> String
resp.results[0][0].value #=> String
resp.statistics.records_matched #=> Float
resp.statistics.records_scanned #=> Float
resp.statistics.bytes_scanned #=> Float
resp.status #=> String, one of "Scheduled", "Running", "Complete", "Failed", "Cancelled", "Timeout", "Unknown"
resp.encryption_key #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :query_id (required, String) —

    The ID number of the query.

Returns:

See Also:



3033
3034
3035
3036
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3033

def get_query_results(params = {}, options = {})
  req = build_request(:get_query_results, params)
  req.send_request(options)
end

#list_anomalies(params = {}) ⇒ Types::ListAnomaliesResponse

Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_anomalies({
  anomaly_detector_arn: "AnomalyDetectorArn",
  suppression_state: "SUPPRESSED", # accepts SUPPRESSED, UNSUPPRESSED
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.anomalies #=> Array
resp.anomalies[0].anomaly_id #=> String
resp.anomalies[0].pattern_id #=> String
resp.anomalies[0].anomaly_detector_arn #=> String
resp.anomalies[0].pattern_string #=> String
resp.anomalies[0].pattern_regex #=> String
resp.anomalies[0].priority #=> String
resp.anomalies[0].first_seen #=> Integer
resp.anomalies[0].last_seen #=> Integer
resp.anomalies[0].description #=> String
resp.anomalies[0].active #=> Boolean
resp.anomalies[0].state #=> String, one of "Active", "Suppressed", "Baseline"
resp.anomalies[0].histogram #=> Hash
resp.anomalies[0].histogram["Time"] #=> Integer
resp.anomalies[0].log_samples #=> Array
resp.anomalies[0].log_samples[0] #=> String
resp.anomalies[0].pattern_tokens #=> Array
resp.anomalies[0].pattern_tokens[0].dynamic_token_position #=> Integer
resp.anomalies[0].pattern_tokens[0].is_dynamic #=> Boolean
resp.anomalies[0].pattern_tokens[0].token_string #=> String
resp.anomalies[0].pattern_tokens[0].enumerations #=> Hash
resp.anomalies[0].pattern_tokens[0].enumerations["TokenString"] #=> Integer
resp.anomalies[0].log_group_arn_list #=> Array
resp.anomalies[0].log_group_arn_list[0] #=> String
resp.anomalies[0].suppressed #=> Boolean
resp.anomalies[0].suppressed_date #=> Integer
resp.anomalies[0].suppressed_until #=> Integer
resp.anomalies[0].is_pattern_level_suppression #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :anomaly_detector_arn (String) —

    Use this to optionally limit the results to only the anomalies found by a certain anomaly detector.

  • :suppression_state (String) —

    You can specify this parameter if you want to the operation to return only anomalies that are currently either suppressed or unsuppressed.

  • :limit (Integer) —

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

  • :next_token (String) —

    The token for the next set of items to return. The token expires after 24 hours.

Returns:

See Also:



3110
3111
3112
3113
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3110

def list_anomalies(params = {}, options = {})
  req = build_request(:list_anomalies, params)
  req.send_request(options)
end

#list_log_anomaly_detectors(params = {}) ⇒ Types::ListLogAnomalyDetectorsResponse

Retrieves a list of the log anomaly detectors in the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_log_anomaly_detectors({
  filter_log_group_arn: "LogGroupArn",
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.anomaly_detectors #=> Array
resp.anomaly_detectors[0].anomaly_detector_arn #=> String
resp.anomaly_detectors[0].detector_name #=> String
resp.anomaly_detectors[0].log_group_arn_list #=> Array
resp.anomaly_detectors[0].log_group_arn_list[0] #=> String
resp.anomaly_detectors[0].evaluation_frequency #=> String, one of "ONE_MIN", "FIVE_MIN", "TEN_MIN", "FIFTEEN_MIN", "THIRTY_MIN", "ONE_HOUR"
resp.anomaly_detectors[0].filter_pattern #=> String
resp.anomaly_detectors[0].anomaly_detector_status #=> String, one of "INITIALIZING", "TRAINING", "ANALYZING", "FAILED", "DELETED", "PAUSED"
resp.anomaly_detectors[0].kms_key_id #=> String
resp.anomaly_detectors[0].creation_time_stamp #=> Integer
resp.anomaly_detectors[0].last_modified_time_stamp #=> Integer
resp.anomaly_detectors[0].anomaly_visibility_time #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter_log_group_arn (String) —

    Use this to optionally filter the results to only include anomaly detectors that are associated with the specified log group.

  • :limit (Integer) —

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

  • :next_token (String) —

    The token for the next set of items to return. The token expires after 24 hours.

Returns:

See Also:



3164
3165
3166
3167
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3164

def list_log_anomaly_detectors(params = {}, options = {})
  req = build_request(:list_log_anomaly_detectors, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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.

Returns:

See Also:



3207
3208
3209
3210
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3207

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_tags_log_group(params = {}) ⇒ Types::ListTagsLogGroupResponse

The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.

Lists the tags for the specified log group.

Examples:

Request syntax with placeholder values


resp = client.list_tags_log_group({
  log_group_name: "LogGroupName", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

Returns:

See Also:



3243
3244
3245
3246
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3243

def list_tags_log_group(params = {}, options = {})
  req = build_request(:list_tags_log_group, params)
  req.send_request(options)
end

#put_account_policy(params = {}) ⇒ Types::PutAccountPolicyResponse

Creates an account-level data protection policy that applies to all log groups in the account. A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level policy.

Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.

If you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

To use the PutAccountPolicy operation, you must be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy permissions.

The PutAccountPolicy operation applies to all log groups in the account. You can also use PutDataProtectionPolicy to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

Examples:

Request syntax with placeholder values


resp = client.({
  policy_name: "PolicyName", # required
  policy_document: "AccountPolicyDocument", # required
  policy_type: "DATA_PROTECTION_POLICY", # required, accepts DATA_PROTECTION_POLICY
  scope: "ALL", # accepts ALL
})

Response structure


resp..policy_name #=> String
resp..policy_document #=> String
resp..last_updated_time #=> Integer
resp..policy_type #=> String, one of "DATA_PROTECTION_POLICY"
resp..scope #=> String, one of "ALL"
resp.. #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_name (required, String) —

    A name for the policy. This must be unique within the account.

  • :policy_document (required, String) —

    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.

      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, Kinesis Data 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.

  • :policy_type (required, String) —

    Currently the only valid value for this parameter is DATA_PROTECTION_POLICY.

  • :scope (String) —

    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.

Returns:

See Also:



3377
3378
3379
3380
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3377

def (params = {}, options = {})
  req = build_request(:put_account_policy, params)
  req.send_request(options)
end

#put_data_protection_policy(params = {}) ⇒ Types::PutDataProtectionPolicyResponse

Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.

Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

The PutDataProtectionPolicy operation applies to only the specified log group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log groups in the account, including both existing log groups and log groups that are created level. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.

Examples:

Request syntax with placeholder values


resp = client.put_data_protection_policy({
  log_group_identifier: "LogGroupIdentifier", # required
  policy_document: "DataProtectionPolicyDocument", # required
})

Response structure


resp.log_group_identifier #=> String
resp.policy_document #=> String
resp.last_updated_time #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_identifier (required, String) —

    Specify either the log group name or log group ARN.

  • :policy_document (required, String) —

    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.

      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, Kinesis Data 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.

Returns:

See Also:



3487
3488
3489
3490
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3487

def put_data_protection_policy(params = {}, options = {})
  req = build_request(:put_data_protection_policy, params)
  req.send_request(options)
end

#put_delivery_destination(params = {}) ⇒ Types::PutDeliveryDestinationResponse

Creates or updates a logical delivery destination. 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, and Kinesis Data Firehose are supported as logs 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.

  • Use PutDeliveryDestination to 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 in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

  • Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

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.

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.

If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.

Examples:

Request syntax with placeholder values


resp = client.put_delivery_destination({
  name: "DeliveryDestinationName", # required
  output_format: "json", # accepts json, plain, w3c, raw, parquet
  delivery_destination_configuration: { # required
    destination_resource_arn: "Arn", # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.delivery_destination.name #=> String
resp.delivery_destination.arn #=> String
resp.delivery_destination.delivery_destination_type #=> String, one of "S3", "CWL", "FH"
resp.delivery_destination.output_format #=> String, one of "json", "plain", "w3c", "raw", "parquet"
resp.delivery_destination.delivery_destination_configuration.destination_resource_arn #=> String
resp.delivery_destination.tags #=> Hash
resp.delivery_destination.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for this delivery destination. This name must be unique for all delivery destinations in your account.

  • :output_format (String) —

    The format for the logs that this delivery destination will receive.

  • :delivery_destination_configuration (required, Types::DeliveryDestinationConfiguration) —

    A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

  • :tags (Hash<String,String>) —

    An optional list of key-value pairs to associate with the resource.

    For more information about tagging, see Tagging Amazon Web Services resources

Returns:

See Also:



3591
3592
3593
3594
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3591

def put_delivery_destination(params = {}, options = {})
  req = build_request(:put_delivery_destination, params)
  req.send_request(options)
end

#put_delivery_destination_policy(params = {}) ⇒ Types::PutDeliveryDestinationPolicyResponse

Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, 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.

  • Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.

  • Use this operation 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.

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.

The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.

Examples:

Request syntax with placeholder values


resp = client.put_delivery_destination_policy({
  delivery_destination_name: "DeliveryDestinationName", # required
  delivery_destination_policy: "DeliveryDestinationPolicy", # required
})

Response structure


resp.policy.delivery_destination_policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delivery_destination_name (required, String) —

    The name of the delivery destination to assign this policy to.

  • :delivery_destination_policy (required, String) —

    The contents of the policy.

Returns:

See Also:



3658
3659
3660
3661
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3658

def put_delivery_destination_policy(params = {}, options = {})
  req = build_request(:put_delivery_destination_policy, params)
  req.send_request(options)
end

#put_delivery_source(params = {}) ⇒ Types::PutDeliverySourceResponse

Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.

To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:

  • Use PutDeliverySource to create a delivery source, which is a logical object that represents the resource that is actually sending the logs.

  • Use PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.

  • If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

  • Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

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.

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.

If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.

Examples:

Request syntax with placeholder values


resp = client.put_delivery_source({
  name: "DeliverySourceName", # required
  resource_arn: "Arn", # required
  log_type: "LogType", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.delivery_source.name #=> String
resp.delivery_source.arn #=> String
resp.delivery_source.resource_arns #=> Array
resp.delivery_source.resource_arns[0] #=> String
resp.delivery_source.service #=> String
resp.delivery_source.log_type #=> String
resp.delivery_source.tags #=> Hash
resp.delivery_source.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for this delivery source. This name must be unique for all delivery sources in your account.

  • :resource_arn (required, String) —

    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

  • :log_type (required, String) —

    Defines the type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

  • :tags (Hash<String,String>) —

    An optional list of key-value pairs to associate with the resource.

    For more information about tagging, see Tagging Amazon Web Services resources

Returns:

See Also:



3763
3764
3765
3766
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3763

def put_delivery_source(params = {}, options = {})
  req = build_request(:put_delivery_source, params)
  req.send_request(options)
end

#put_destination(params = {}) ⇒ Types::PutDestinationResponse

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.

Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

To perform a PutDestination operation, you must also have the iam:PassRole permission.

Examples:

Request syntax with placeholder values


resp = client.put_destination({
  destination_name: "DestinationName", # required
  target_arn: "TargetArn", # required
  role_arn: "RoleArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.destination.destination_name #=> String
resp.destination.target_arn #=> String
resp.destination.role_arn #=> String
resp.destination.access_policy #=> String
resp.destination.arn #=> String
resp.destination.creation_time #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_name (required, String) —

    A name for the destination.

  • :target_arn (required, String) —

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

  • :role_arn (required, String) —

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

  • :tags (Hash<String,String>) —

    An optional list of key-value pairs to associate with the resource.

    For more information about tagging, see Tagging Amazon Web Services resources

Returns:

See Also:



3841
3842
3843
3844
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3841

def put_destination(params = {}, options = {})
  req = build_request(:put_destination, params)
  req.send_request(options)
end

#put_destination_policy(params = {}) ⇒ Struct

Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

Examples:

Request syntax with placeholder values


resp = client.put_destination_policy({
  destination_name: "DestinationName", # required
  access_policy: "AccessPolicy", # required
  force_update: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :destination_name (required, String) —

    A name for an existing destination.

  • :access_policy (required, String) —

    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.

  • :force_update (Boolean) —

    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

    If you omit this parameter, the default of false is used.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3894
3895
3896
3897
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3894

def put_destination_policy(params = {}, options = {})
  req = build_request(:put_destination_policy, params)
  req.send_request(options)
end

#put_log_events(params = {}) ⇒ Types::PutLogEventsResponse

Uploads a batch of log events to the specified log stream.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.

  • The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

  • Each log event can be no larger than 256 KB.

  • The maximum number of log events in a batch is 10,000.

  • The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.

Examples:

Request syntax with placeholder values


resp = client.put_log_events({
  log_group_name: "LogGroupName", # required
  log_stream_name: "LogStreamName", # required
  log_events: [ # required
    {
      timestamp: 1, # required
      message: "EventMessage", # required
    },
  ],
  sequence_token: "SequenceToken",
})

Response structure


resp.next_sequence_token #=> String
resp.rejected_log_events_info.too_new_log_event_start_index #=> Integer
resp.rejected_log_events_info.too_old_log_event_end_index #=> Integer
resp.rejected_log_events_info.expired_log_event_end_index #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :log_stream_name (required, String) —

    The name of the log stream.

  • :log_events (required, Array<Types::InputLogEvent>) —

    The log events.

  • :sequence_token (String) —

    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.

Returns:

See Also:



3991
3992
3993
3994
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3991

def put_log_events(params = {}, options = {})
  req = build_request(:put_log_events, params)
  req.send_request(options)
end

#put_metric_filter(params = {}) ⇒ Struct

Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.

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.

Examples:

Request syntax with placeholder values


resp = client.put_metric_filter({
  log_group_name: "LogGroupName", # required
  filter_name: "FilterName", # required
  filter_pattern: "FilterPattern", # required
  metric_transformations: [ # required
    {
      metric_name: "MetricName", # required
      metric_namespace: "MetricNamespace", # required
      metric_value: "MetricValue", # required
      default_value: 1.0,
      dimensions: {
        "DimensionsKey" => "DimensionsValue",
      },
      unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :filter_name (required, String) —

    A name for the metric filter.

  • :filter_pattern (required, String) —

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

  • :metric_transformations (required, Array<Types::MetricTransformation>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4065
4066
4067
4068
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4065

def put_metric_filter(params = {}, options = {})
  req = build_request(:put_metric_filter, params)
  req.send_request(options)
end

#put_query_definition(params = {}) ⇒ Types::PutQueryDefinitionResponse

Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.

To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.

You must have the logs:PutQueryDefinition permission to be able to perform this operation.

Examples:

Request syntax with placeholder values


resp = client.put_query_definition({
  name: "QueryDefinitionName", # required
  query_definition_id: "QueryId",
  log_group_names: ["LogGroupName"],
  query_string: "QueryDefinitionString", # required
  client_token: "ClientToken",
})

Response structure


resp.query_definition_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    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.

  • :query_definition_id (String) —

    If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

    If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

  • :log_group_names (Array<String>) —

    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.

  • :query_string (required, String) —

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

  • :client_token (String) —

    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.**

Returns:

See Also:



4159
4160
4161
4162
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4159

def put_query_definition(params = {}, options = {})
  req = build_request(:put_query_definition, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse

Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  policy_name: "PolicyName",
  policy_document: "PolicyDocument",
})

Response structure


resp.resource_policy.policy_name #=> String
resp.resource_policy.policy_document #=> String
resp.resource_policy.last_updated_time #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_name (String) —

    Name of the new policy. This parameter is required.

  • :policy_document (String) —

    Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.

    The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

    CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

    In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs. 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" \} \} \} ] \}

Returns:

See Also:



4225
4226
4227
4228
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4225

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#put_retention_policy(params = {}) ⇒ Struct

Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the storedBytes value to see how many bytes a log group is storing.

Examples:

Request syntax with placeholder values


resp = client.put_retention_policy({
  log_group_name: "LogGroupName", # required
  retention_in_days: 1, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :retention_in_days (required, Integer) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4285
4286
4287
4288
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4285

def put_retention_policy(params = {}, options = {})
  req = build_request(:put_retention_policy, params)
  req.send_request(options)
end

#put_subscription_filter(params = {}) ⇒ Struct

Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

  • An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Kinesis Data Firehose as logical destinations.

  • An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.

To perform a PutSubscriptionFilter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.

Examples:

Request syntax with placeholder values


resp = client.put_subscription_filter({
  log_group_name: "LogGroupName", # required
  filter_name: "FilterName", # required
  filter_pattern: "FilterPattern", # required
  destination_arn: "DestinationArn", # required
  role_arn: "RoleArn",
  distribution: "Random", # accepts Random, ByLogStream
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :filter_name (required, String) —

    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.

  • :filter_pattern (required, String) —

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

  • :destination_arn (required, String) —

    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.

    • 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.

  • :role_arn (String) —

    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.

  • :distribution (String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4396
4397
4398
4399
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4396

def put_subscription_filter(params = {}, options = {})
  req = build_request(:put_subscription_filter, params)
  req.send_request(options)
end

#start_query(params = {}) ⇒ Types::StartQueryResponse

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax.

After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the queryId that StartQuery returns.

If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.

Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.

You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.

Examples:

Request syntax with placeholder values


resp = client.start_query({
  log_group_name: "LogGroupName",
  log_group_names: ["LogGroupName"],
  log_group_identifiers: ["LogGroupIdentifier"],
  start_time: 1, # required
  end_time: 1, # required
  query_string: "QueryString", # required
  limit: 1,
})

Response structure


resp.query_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (String) —

    The log group on which to perform the query.

    A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

  • :log_group_names (Array<String>) —

    The list of log groups to be queried. You can include up to 50 log groups.

    A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

  • :log_group_identifiers (Array<String>) —

    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.

  • :start_time (required, Integer) —

    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.

  • :end_time (required, Integer) —

    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.

  • :query_string (required, String) —

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

  • :limit (Integer) —

    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.

Returns:

See Also:



4514
4515
4516
4517
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4514

def start_query(params = {}, options = {})
  req = build_request(:start_query, params)
  req.send_request(options)
end

#stop_query(params = {}) ⇒ Types::StopQueryResponse

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

Examples:

Request syntax with placeholder values


resp = client.stop_query({
  query_id: "QueryId", # required
})

Response structure


resp.success #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :query_id (required, String) —

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

Returns:

See Also:



4545
4546
4547
4548
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4545

def stop_query(params = {}, options = {})
  req = build_request(:stop_query, params)
  req.send_request(options)
end

#tag_log_group(params = {}) ⇒ Struct

The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

Examples:

Request syntax with placeholder values


resp = client.tag_log_group({
  log_group_name: "LogGroupName", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :tags (required, Hash<String,String>) —

    The key-value pairs to use for the tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4596
4597
4598
4599
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4596

def tag_log_group(params = {}, options = {})
  req = build_request(:tag_log_group, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch Logs resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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.

  • :tags (required, Hash<String,String>) —

    The list of key-value pairs to associate with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4654
4655
4656
4657
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4654

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#test_metric_filter(params = {}) ⇒ Types::TestMetricFilterResponse

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

Examples:

Request syntax with placeholder values


resp = client.test_metric_filter({
  filter_pattern: "FilterPattern", # required
  log_event_messages: ["EventMessage"], # required
})

Response structure


resp.matches #=> Array
resp.matches[0].event_number #=> Integer
resp.matches[0].event_message #=> String
resp.matches[0].extracted_values #=> Hash
resp.matches[0].extracted_values["Token"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filter_pattern (required, String) —

    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.

  • :log_event_messages (required, Array<String>) —

    The log event messages to test.

Returns:

See Also:



4695
4696
4697
4698
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4695

def test_metric_filter(params = {}, options = {})
  req = build_request(:test_metric_filter, params)
  req.send_request(options)
end

#untag_log_group(params = {}) ⇒ Struct

The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys.

Examples:

Request syntax with placeholder values


resp = client.untag_log_group({
  log_group_name: "LogGroupName", # required
  tags: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :tags (required, Array<String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4737
4738
4739
4740
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4737

def untag_log_group(params = {}, options = {})
  req = build_request(:untag_log_group, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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.

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4777
4778
4779
4780
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4777

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_anomaly(params = {}) ⇒ Struct

Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.

You must specify either anomalyId or patternId, but you can't specify both parameters in the same operation.

If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to stop suppressing, and omit the suppressionType and suppressionPeriod parameters.

Examples:

Request syntax with placeholder values


resp = client.update_anomaly({
  anomaly_id: "AnomalyId",
  pattern_id: "PatternId",
  anomaly_detector_arn: "AnomalyDetectorArn", # required
  suppression_type: "LIMITED", # accepts LIMITED, INFINITE
  suppression_period: {
    value: 1,
    suppression_unit: "SECONDS", # accepts SECONDS, MINUTES, HOURS
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :anomaly_id (String) —

    If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can find anomaly IDs by using the ListAnomalies operation.

  • :pattern_id (String) —

    If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can find pattern IDs by using the ListAnomalies operation.

  • :anomaly_detector_arn (required, String) —

    The ARN of the anomaly detector that this operation is to act on.

  • :suppression_type (String) —

    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.

  • :suppression_period (Types::SuppressionPeriod) —

    If you are temporarily suppressing an anomaly or pattern, use this structure to specify how long the suppression is to last.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4847
4848
4849
4850
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4847

def update_anomaly(params = {}, options = {})
  req = build_request(:update_anomaly, params)
  req.send_request(options)
end

#update_log_anomaly_detector(params = {}) ⇒ Struct

Updates an existing log anomaly detector.

Examples:

Request syntax with placeholder values


resp = client.update_log_anomaly_detector({
  anomaly_detector_arn: "AnomalyDetectorArn", # required
  evaluation_frequency: "ONE_MIN", # accepts ONE_MIN, FIVE_MIN, TEN_MIN, FIFTEEN_MIN, THIRTY_MIN, ONE_HOUR
  filter_pattern: "FilterPattern",
  anomaly_visibility_time: 1,
  enabled: false, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :anomaly_detector_arn (required, String) —

    The ARN of the anomaly detector that you want to update.

  • :evaluation_frequency (String) —

    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.

  • :filter_pattern (String) —

    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.

  • :anomaly_visibility_time (Integer) —

    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.

  • :enabled (required, Boolean) —

    Use this parameter to pause or restart the anomaly detector.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4897
4898
4899
4900
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4897

def update_log_anomaly_detector(params = {}, options = {})
  req = build_request(:update_log_anomaly_detector, params)
  req.send_request(options)
end