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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

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

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

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

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

  • :validate_params (Boolean) — default: true —

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

  • :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 (Integer) — 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.

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



334
335
336
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#associate_kms_key(params = {}) ⇒ Struct

Associates the specified Key Management Service customer master key (CMK) with the specified log group.

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

CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. 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 CMK with a log group but the CMK does not exist or the CMK is disabled, you receive an InvalidParameterException error.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



391
392
393
394
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 391

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:



415
416
417
418
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 415

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

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

Creates an export task, which allows you to 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.

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 out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

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

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, expreswatchlogsdocused as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

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



498
499
500
501
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 498

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

#create_log_group(params = {}) ⇒ Struct

Creates a log group with the specified name. You can create up to 20,000 log groups 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 never expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

If you associate a Key Management Service customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

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

CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK 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",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :log_group_name (required, String) —

    The name of the log group.

  • :kms_key_id (String) —

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

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

    The key-value pairs to use for the tags.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



581
582
583
584
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 581

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.

  • The ':' (colon) and '*' (asterisk) characters are not allowed.

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:



621
622
623
624
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 621

def create_log_stream(params = {}, options = {})
  req = build_request(:create_log_stream, 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:



645
646
647
648
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 645

def delete_destination(params = {}, options = {})
  req = build_request(:delete_destination, 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:



668
669
670
671
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 668

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:



695
696
697
698
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 695

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:



721
722
723
724
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 721

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:



763
764
765
766
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 763

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:



786
787
788
789
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 786

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:



811
812
813
814
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 811

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:



837
838
839
840
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 837

def delete_subscription_filter(params = {}, options = {})
  req = build_request(:delete_subscription_filter, 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 is up to 50 items.

Returns:

See Also:



887
888
889
890
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 887

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 zero or one 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:



945
946
947
948
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 945

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.

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({
  log_group_name_prefix: "LogGroupName",
  next_token: "NextToken",
  limit: 1,
})

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.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :log_group_name_prefix (String) —

    The prefix to match.

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



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

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.

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

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", # required
  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 (required, String) —

    The name of the log group.

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



1090
1091
1092
1093
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1090

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



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

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, executing, or have been executed 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:



1216
1217
1218
1219
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1216

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:



1268
1269
1270
1271
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1268

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:



1307
1308
1309
1310
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1307

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:



1363
1364
1365
1366
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1363

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 associated Key Management Service customer master key (CMK) from the specified log group.

After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.

Note that 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", # 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:



1394
1395
1396
1397
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1394

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.

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 time range that you specify. If the results include a token, then there are more log events available, and 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.

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", # required
  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,
})

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 (required, String) —

    The name of the log group to search.

  • :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 makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

    Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Returns:

See Also:



1512
1513
1514
1515
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1512

def filter_log_events(params = {}, options = {})
  req = build_request(:filter_log_events, 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.

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", # required
  log_stream_name: "LogStreamName", # required
  start_time: 1,
  end_time: 1,
  next_token: "NextToken",
  limit: 1,
  start_from_head: 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 (required, String) —

    The name of the log group.

  • :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 value, the maximum 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.

Returns:

See Also:



1594
1595
1596
1597
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1594

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, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.

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.

Examples:

Request syntax with placeholder values


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

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 (required, String) —

    The name of the log group to search.

  • :time (Integer) —

    The time to set as the center of the query. If you specify time, the 15 minutes before this time are queries. If you omit time the 8 minutes before and 8 minutes after this time are searched.

    The time value is specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

See Also:



1648
1649
1650
1651
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1648

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

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.

Returns:

See Also:



1686
1687
1688
1689
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1686

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 a query execution. To run a query, use StartQuery.

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.

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"

Parameters:

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

    ({})

Options Hash (params):

  • :query_id (required, String) —

    The ID number of the query.

Returns:

See Also:



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

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

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

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:



1770
1771
1772
1773
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1770

def list_tags_log_group(params = {}, options = {})
  req = build_request(:list_tags_log_group, 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) and enables you to 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
})

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.

Returns:

See Also:



1834
1835
1836
1837
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1834

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.

If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be listed separately in the policy. The policy does not support specifying * as the Principal or the use of the aws:PrincipalOrgId global key.

Examples:

Request syntax with placeholder values


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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1874
1875
1876
1877
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1874

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.

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected.

The 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 older than 14 days or older 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 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.

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

  • There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid 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. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected.

Returns:

See Also:



1971
1972
1973
1974
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1971

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. Metric filters allow you to 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.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

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:



2045
2046
2047
2048
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2045

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, if you update a current query definition that includes log groups, and 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
})

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 a lot of query definitions, we recommend that you name them so that you can easily find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

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

Returns:

See Also:



2131
2132
2133
2134
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2131

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 and replace the value of SourceAccount with the Amazon Web Services account ID making that call.

    \{ "Version": "2012-10-17", "Statement": [ \{ "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": \{ "Service": [ "route53.amazonaws.com" ] \}, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": \{ "ArnLike": \{ "aws:SourceArn": "myRoute53ResourceArn" \}, "StringEquals": \{ "aws:SourceAccount": "myAwsAccountId" \} \} \} ] \}

Returns:

See Also:



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

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. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.

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, 1827, and 3653.

    To set a log group to never have log events expire, use DeleteRetentionPolicy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2234
2235
2236
2237
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2234

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. Subscription filters allow you to 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 stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination that belongs to a different account, for cross-account delivery.

  • An Amazon Kinesis 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, 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 are setting up a cross-account subscription, the destination must have an IAM policy associated with it that allows the sender to send logs to the destination. For more information, see PutDestinationPolicy.

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

    • A Lambda function belonging to the same account as the subscription filter, for same-account delivery.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2341
2342
2343
2344
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2341

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.

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

Examples:

Request syntax with placeholder values


resp = client.start_query({
  log_group_name: "LogGroupName",
  log_group_names: ["LogGroupName"],
  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 a logGroupNames or a logGroupName parameter, but not both.

  • :log_group_names (Array<String>) —

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

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

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



2419
2420
2421
2422
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2419

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:



2450
2451
2452
2453
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2450

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

#tag_log_group(params = {}) ⇒ Struct

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

To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.

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:



2497
2498
2499
2500
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2497

def tag_log_group(params = {}, options = {})
  req = build_request(:tag_log_group, 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:



2538
2539
2540
2541
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2538

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

#untag_log_group(params = {}) ⇒ Struct

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To add tags, use TagLogGroup.

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:



2576
2577
2578
2579
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2576

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