You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

    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 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails 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 search 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.

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

  • :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 endpoints. This should be avalid 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. Defaults to false.

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

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

    @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 and auth errors from expired credentials.

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

  • :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 rasing 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 yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble 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 yeidled by #session_for.

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



255
256
257
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 255

def initialize(*args)
  super
end

Instance Method Details

#associate_kms_key(params = {}) ⇒ Struct

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

Associating an AWS 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 Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

Note that 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 will 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:



304
305
306
307
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 304

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:



328
329
330
331
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 328

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.

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.

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.

  • :destination (required, String) —

    The name of S3 bucket for the exported log data. The bucket must be in the same AWS 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:



400
401
402
403
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 400

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 5000 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 AWS 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), and '.' (period).

If you associate a AWS Key Management Service (AWS KMS) 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 Amazon CloudWatch Logs. This enables Amazon 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 will receive an InvalidParameterException error.

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 - AWS Key Management Service (AWS KMS).

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

    The key-value pairs to use for the tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



460
461
462
463
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 460

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.

There is no limit on the number of log streams that you can create for a log group.

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:



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

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:



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

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:



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

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:



571
572
573
574
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 571

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:



597
598
599
600
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 597

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



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

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:



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

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:



671
672
673
674
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 671

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.

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:



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

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:



777
778
779
780
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 777

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.

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:



826
827
828
829
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 826

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.

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 may take longer in some rare situations.

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



907
908
909
910
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 907

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 the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

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

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



974
975
976
977
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 974

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



1027
1028
1029
1030
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1027

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



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

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.

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:



1120
1121
1122
1123
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1120

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

After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS 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:



1152
1153
1154
1155
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1152

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.

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.

Returns:

See Also:



1257
1258
1259
1260
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1257

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

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.

Returns:

See Also:



1331
1332
1333
1334
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1331

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.

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 8 minutes before and 8 minutes after this time are searched. If you omit time, the past 15 minutes are queried.

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

Returns:

See Also:



1380
1381
1382
1383
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1380

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

Additionally, the entire 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:



1419
1420
1421
1422
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1419

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. If the query is in progress, partial results of that current execution are returned. Only the fields requested in the query are returned.

GetQueryResults does not start a query execution. To run a query, use .

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"

Parameters:

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

    ({})

Options Hash (params):

  • :query_id (required, String) —

    The ID number of the query.

Returns:

See Also:



1461
1462
1463
1464
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1461

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:



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

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. 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. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.

Through an access policy, a destination controls what is written to its Kinesis stream. 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.

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:



1545
1546
1547
1548
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1545

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

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1579
1580
1581
1582
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1579

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 using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes, and 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 the retention period of the log group.

  • The log events in the batch must be in chronological ordered 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 AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

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

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

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS 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 may be successful, or one may be rejected.

Returns:

See Also:



1667
1668
1669
1670
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1667

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.

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

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:



1714
1715
1716
1717
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1714

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

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

Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per 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.

    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.

    \{ "Version": "2012-10-17", "Statement": [ \{ "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": \{ "Service": [ "route53.amazonaws.com" ] \}, "Action":"logs:PutLogEvents", "Resource": "logArn" \} ] \}

Returns:

See Also:



1762
1763
1764
1765
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1762

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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1792
1793
1794
1795
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1792

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. 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 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 AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

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. Otherwise, the call fails because you cannot associate a second filter with a log group. 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.

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

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



1878
1879
1880
1881
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1878

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.

Examples:

Request syntax with placeholder values


resp = client.start_query({
  log_group_name: "LogGroupName", # required
  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 (required, String) —

    The log group on which to perform the query.

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

Returns:

See Also:



1941
1942
1943
1944
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1941

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. If necessary, you can use DescribeQueries to find this ID number.

Returns:

See Also:



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

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.

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:



2010
2011
2012
2013
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2010

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 may contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

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

    The log event messages to test.

Returns:

See Also:



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

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

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:



2080
2081
2082
2083
 
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2080

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