Class: Aws::CloudWatchLogs::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudWatchLogs::Client
- 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
API Operations collapse
-
#associate_kms_key(params = {}) ⇒ Struct
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
-
#cancel_export_task(params = {}) ⇒ Struct
Cancels the specified export task.
-
#create_delivery(params = {}) ⇒ Types::CreateDeliveryResponse
Creates a delivery.
-
#create_export_task(params = {}) ⇒ Types::CreateExportTaskResponse
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket.
-
#create_log_anomaly_detector(params = {}) ⇒ Types::CreateLogAnomalyDetectorResponse
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.
-
#create_log_group(params = {}) ⇒ Struct
Creates a log group with the specified name.
-
#create_log_stream(params = {}) ⇒ Struct
Creates a log stream for the specified log group.
-
#delete_account_policy(params = {}) ⇒ Struct
Deletes a CloudWatch Logs account policy.
-
#delete_data_protection_policy(params = {}) ⇒ Struct
Deletes the data protection policy from the specified log group.
-
#delete_delivery(params = {}) ⇒ Struct
Deletes s delivery.
-
#delete_delivery_destination(params = {}) ⇒ Struct
Deletes a delivery destination.
-
#delete_delivery_destination_policy(params = {}) ⇒ Struct
Deletes a delivery destination policy.
-
#delete_delivery_source(params = {}) ⇒ Struct
Deletes a delivery source.
-
#delete_destination(params = {}) ⇒ Struct
Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
-
#delete_log_anomaly_detector(params = {}) ⇒ Struct
Deletes the specified CloudWatch Logs anomaly detector.
-
#delete_log_group(params = {}) ⇒ Struct
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
-
#delete_log_stream(params = {}) ⇒ Struct
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
-
#delete_metric_filter(params = {}) ⇒ Struct
Deletes the specified metric filter.
-
#delete_query_definition(params = {}) ⇒ Types::DeleteQueryDefinitionResponse
Deletes a saved CloudWatch Logs Insights query definition.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a resource policy from this account.
-
#delete_retention_policy(params = {}) ⇒ Struct
Deletes the specified retention policy.
-
#delete_subscription_filter(params = {}) ⇒ Struct
Deletes the specified subscription filter.
-
#describe_account_policies(params = {}) ⇒ Types::DescribeAccountPoliciesResponse
Returns a list of all CloudWatch Logs account policies in the account.
-
#describe_configuration_templates(params = {}) ⇒ Types::DescribeConfigurationTemplatesResponse
Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries.
-
#describe_deliveries(params = {}) ⇒ Types::DescribeDeliveriesResponse
Retrieves a list of the deliveries that have been created in the account.
-
#describe_delivery_destinations(params = {}) ⇒ Types::DescribeDeliveryDestinationsResponse
Retrieves a list of the delivery destinations that have been created in the account.
-
#describe_delivery_sources(params = {}) ⇒ Types::DescribeDeliverySourcesResponse
Retrieves a list of the delivery sources that have been created in the account.
-
#describe_destinations(params = {}) ⇒ Types::DescribeDestinationsResponse
Lists all your destinations.
-
#describe_export_tasks(params = {}) ⇒ Types::DescribeExportTasksResponse
Lists the specified export tasks.
-
#describe_log_groups(params = {}) ⇒ Types::DescribeLogGroupsResponse
Lists the specified log groups.
-
#describe_log_streams(params = {}) ⇒ Types::DescribeLogStreamsResponse
Lists the log streams for the specified log group.
-
#describe_metric_filters(params = {}) ⇒ Types::DescribeMetricFiltersResponse
Lists the specified metric filters.
-
#describe_queries(params = {}) ⇒ Types::DescribeQueriesResponse
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account.
-
#describe_query_definitions(params = {}) ⇒ Types::DescribeQueryDefinitionsResponse
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
-
#describe_resource_policies(params = {}) ⇒ Types::DescribeResourcePoliciesResponse
Lists the resource policies in this account.
-
#describe_subscription_filters(params = {}) ⇒ Types::DescribeSubscriptionFiltersResponse
Lists the subscription filters for the specified log group.
-
#disassociate_kms_key(params = {}) ⇒ Struct
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
-
#filter_log_events(params = {}) ⇒ Types::FilterLogEventsResponse
Lists log events from the specified log group.
-
#get_data_protection_policy(params = {}) ⇒ Types::GetDataProtectionPolicyResponse
Returns information about a log group data protection policy.
-
#get_delivery(params = {}) ⇒ Types::GetDeliveryResponse
Returns complete information about one logical delivery.
-
#get_delivery_destination(params = {}) ⇒ Types::GetDeliveryDestinationResponse
Retrieves complete information about one delivery destination.
-
#get_delivery_destination_policy(params = {}) ⇒ Types::GetDeliveryDestinationPolicyResponse
Retrieves the delivery destination policy assigned to the delivery destination that you specify.
-
#get_delivery_source(params = {}) ⇒ Types::GetDeliverySourceResponse
Retrieves complete information about one delivery source.
-
#get_log_anomaly_detector(params = {}) ⇒ Types::GetLogAnomalyDetectorResponse
Retrieves information about the log anomaly detector that you specify.
-
#get_log_events(params = {}) ⇒ Types::GetLogEventsResponse
Lists log events from the specified log stream.
-
#get_log_group_fields(params = {}) ⇒ Types::GetLogGroupFieldsResponse
Returns a list of the fields that are included in log events in the specified log group.
-
#get_log_record(params = {}) ⇒ Types::GetLogRecordResponse
Retrieves all of the fields and values of a single log event.
-
#get_query_results(params = {}) ⇒ Types::GetQueryResultsResponse
Returns the results from the specified query.
-
#list_anomalies(params = {}) ⇒ Types::ListAnomaliesResponse
Returns a list of anomalies that log anomaly detectors have found.
-
#list_log_anomaly_detectors(params = {}) ⇒ Types::ListLogAnomalyDetectorsResponse
Retrieves a list of the log anomaly detectors in the account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with a CloudWatch Logs resource.
-
#list_tags_log_group(params = {}) ⇒ Types::ListTagsLogGroupResponse
The ListTagsLogGroup operation is on the path to deprecation.
-
#put_account_policy(params = {}) ⇒ Types::PutAccountPolicyResponse
Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.
-
#put_data_protection_policy(params = {}) ⇒ Types::PutDataProtectionPolicyResponse
Creates a data protection policy for the specified log group.
-
#put_delivery_destination(params = {}) ⇒ Types::PutDeliveryDestinationResponse
Creates or updates a logical delivery destination.
-
#put_delivery_destination_policy(params = {}) ⇒ Types::PutDeliveryDestinationPolicyResponse
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.
-
#put_delivery_source(params = {}) ⇒ Types::PutDeliverySourceResponse
Creates or updates a logical delivery source.
-
#put_destination(params = {}) ⇒ Types::PutDestinationResponse
Creates or updates a destination.
-
#put_destination_policy(params = {}) ⇒ Struct
Creates or updates an access policy associated with an existing destination.
-
#put_log_events(params = {}) ⇒ Types::PutLogEventsResponse
Uploads a batch of log events to the specified log stream.
-
#put_metric_filter(params = {}) ⇒ Struct
Creates or updates a metric filter and associates it with the specified log group.
-
#put_query_definition(params = {}) ⇒ Types::PutQueryDefinitionResponse
Creates or updates a query definition for CloudWatch Logs Insights.
-
#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.
-
#put_retention_policy(params = {}) ⇒ Struct
Sets the retention of the specified log group.
-
#put_subscription_filter(params = {}) ⇒ Struct
Creates or updates a subscription filter and associates it with the specified log group.
-
#start_live_tail(params = {}) ⇒ Types::StartLiveTailResponse
Starts a Live Tail streaming session for one or more log groups.
-
#start_query(params = {}) ⇒ Types::StartQueryResponse
Schedules a query of a log group using CloudWatch Logs Insights.
-
#stop_query(params = {}) ⇒ Types::StopQueryResponse
Stops a CloudWatch Logs Insights query that is in progress.
-
#tag_log_group(params = {}) ⇒ Struct
The TagLogGroup operation is on the path to deprecation.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.
-
#test_metric_filter(params = {}) ⇒ Types::TestMetricFilterResponse
Tests the filter pattern of a metric filter against a sample of log event messages.
-
#untag_log_group(params = {}) ⇒ Struct
The UntagLogGroup operation is on the path to deprecation.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
-
#update_anomaly(params = {}) ⇒ Struct
Use this operation to suppress anomaly detection for a specified anomaly or pattern.
-
#update_delivery_configuration(params = {}) ⇒ Struct
Use this operation to update the configuration of a [delivery][1] to change either the S3 path pattern or the format of the delivered logs.
-
#update_log_anomaly_detector(params = {}) ⇒ Struct
Updates an existing log anomaly detector.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
462 463 464 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 462 def initialize(*args) super end |
Instance Method Details
#associate_kms_key(params = {}) ⇒ Struct
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use AssociateKmsKey
, you specify either the logGroupName
parameter or the resourceIdentifier
parameter. You can't specify
both of those parameters in the same operation.
Specify the
logGroupName
parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an
AssociateKmsKey
operation with theresourceIdentifier
parameter that specifies aquery-result
resource.Specify the
resourceIdentifier
parameter with aquery-result
resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key
does not exist or the KMS key is disabled, you receive an
InvalidParameterException
error.
589 590 591 592 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 589 def associate_kms_key(params = {}, = {}) req = build_request(:associate_kms_key, params) req.send_request() end |
#cancel_export_task(params = {}) ⇒ Struct
Cancels the specified export task.
The task must be in the PENDING
or RUNNING
state.
613 614 615 616 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 613 def cancel_export_task(params = {}, = {}) req = build_request(:cancel_export_task, params) req.send_request() end |
#create_delivery(params = {}) ⇒ Types::CreateDeliveryResponse
Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.
Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
To update an existing delivery configuration, use UpdateDeliveryConfiguration.
733 734 735 736 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 733 def create_delivery(params = {}, = {}) req = build_request(:create_delivery, params) req.send_request() end |
#create_export_task(params = {}) ⇒ Types::CreateExportTaskResponse
Creates an export task so that you can efficiently export data from a
log group to an Amazon S3 bucket. When you perform a
CreateExportTask
operation, you must use credentials that have
permission to write to the S3 bucket that you specify as the
destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
This is an asynchronous call. If all the required information is
provided, this operation initiates an export task and responds with
the ID of the task. After the task has started, you can use
DescribeExportTasks to get the status of the export task. Each
account can only have one active (RUNNING
or PENDING
) export task
at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
832 833 834 835 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 832 def create_export_task(params = {}, = {}) req = build_request(:create_export_task, params) req.send_request() end |
#create_log_anomaly_detector(params = {}) ⇒ Types::CreateLogAnomalyDetectorResponse
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.
An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.
The anomaly detector uses pattern recognition to find anomalies
,
which are unusual log events. It uses the evaluationFrequency
to
compare current log events and patterns with trained baselines.
Fields within a pattern are called tokens. Fields that vary within a
pattern, such as a request ID or timestamp, are referred to as
dynamic tokens and represented by <*>
.
The following is an example of a pattern:
[INFO] Request time: <*> ms
This pattern represents log events like [INFO] Request time: 327 ms
and other similar log events that differ only by the number, in this
csse 327. When the pattern is displayed, the different numbers are
replaced by <*>
958 959 960 961 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 958 def create_log_anomaly_detector(params = {}, = {}) req = build_request(:create_log_anomaly_detector, params) req.send_request() end |
#create_log_group(params = {}) ⇒ Struct
Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.
You must use the following guidelines when naming a log group:
Log group names must be unique within a Region for an Amazon Web Services account.
Log group names can be between 1 and 512 characters long.
Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign)
Log group names can't start with the string
aws/
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS
key does not exist or the KMS key is disabled, you receive an
InvalidParameterException
error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
1067 1068 1069 1070 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1067 def create_log_group(params = {}, = {}) req = build_request(:create_log_group, params) req.send_request() end |
#create_log_stream(params = {}) ⇒ Struct
Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for
a log group. There is a limit of 50 TPS on CreateLogStream
operations, after which transactions are throttled.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
Don't use ':' (colon) or '*' (asterisk) characters.
1107 1108 1109 1110 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1107 def create_log_stream(params = {}, = {}) req = build_request(:create_log_stream, params) req.send_request() end |
#delete_account_policy(params = {}) ⇒ Struct
Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups or a subset of log groups in the account. Log-group level policies will still be in effect.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are deleting.
To delete a data protection policy, you must have the
logs:DeleteDataProtectionPolicy
andlogs:DeleteAccountPolicy
permissions.To delete a subscription filter policy, you must have the
logs:DeleteSubscriptionFilter
andlogs:DeleteAccountPolicy
permissions.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1146 def delete_account_policy(params = {}, = {}) req = build_request(:delete_account_policy, params) req.send_request() end |
#delete_data_protection_policy(params = {}) ⇒ Struct
Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
1176 1177 1178 1179 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1176 def delete_data_protection_policy(params = {}, = {}) req = build_request(:delete_data_protection_policy, params) req.send_request() end |
#delete_delivery(params = {}) ⇒ Struct
Deletes s delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1207 def delete_delivery(params = {}, = {}) req = build_request(:delete_delivery, params) req.send_request() end |
#delete_delivery_destination(params = {}) ⇒ Struct
Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery destination if any current deliveries are
associated with it. To find whether any deliveries are associated with
this delivery destination, use the DescribeDeliveries operation
and check the deliveryDestinationArn
field in the results.
1245 1246 1247 1248 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1245 def delete_delivery_destination(params = {}, = {}) req = build_request(:delete_delivery_destination, params) req.send_request() end |
#delete_delivery_destination_policy(params = {}) ⇒ Struct
Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1273 def delete_delivery_destination_policy(params = {}, = {}) req = build_request(:delete_delivery_destination_policy, params) req.send_request() end |
#delete_delivery_source(params = {}) ⇒ Struct
Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery source if any current deliveries are
associated with it. To find whether any deliveries are associated with
this delivery source, use the DescribeDeliveries operation and
check the deliverySourceName
field in the results.
1305 1306 1307 1308 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1305 def delete_delivery_source(params = {}, = {}) req = build_request(:delete_delivery_source, params) req.send_request() 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.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1329 def delete_destination(params = {}, = {}) req = build_request(:delete_destination, params) req.send_request() end |
#delete_log_anomaly_detector(params = {}) ⇒ Struct
Deletes the specified CloudWatch Logs anomaly detector.
1357 1358 1359 1360 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1357 def delete_log_anomaly_detector(params = {}, = {}) req = build_request(:delete_log_anomaly_detector, params) req.send_request() end |
#delete_log_group(params = {}) ⇒ Struct
Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
1380 1381 1382 1383 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1380 def delete_log_group(params = {}, = {}) req = build_request(:delete_log_group, params) req.send_request() end |
#delete_log_stream(params = {}) ⇒ Struct
Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
1407 1408 1409 1410 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1407 def delete_log_stream(params = {}, = {}) req = build_request(:delete_log_stream, params) req.send_request() end |
#delete_metric_filter(params = {}) ⇒ Struct
Deletes the specified metric filter.
1433 1434 1435 1436 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1433 def delete_metric_filter(params = {}, = {}) req = build_request(:delete_metric_filter, params) req.send_request() 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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1475 def delete_query_definition(params = {}, = {}) req = build_request(:delete_query_definition, params) req.send_request() 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.
1498 1499 1500 1501 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1498 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() 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.
1523 1524 1525 1526 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1523 def delete_retention_policy(params = {}, = {}) req = build_request(:delete_retention_policy, params) req.send_request() end |
#delete_subscription_filter(params = {}) ⇒ Struct
Deletes the specified subscription filter.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1549 def delete_subscription_filter(params = {}, = {}) req = build_request(:delete_subscription_filter, params) req.send_request() end |
#describe_account_policies(params = {}) ⇒ Types::DescribeAccountPoliciesResponse
Returns a list of all CloudWatch Logs account policies in the account.
1601 1602 1603 1604 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1601 def describe_account_policies(params = {}, = {}) req = build_request(:describe_account_policies, params) req.send_request() end |
#describe_configuration_templates(params = {}) ⇒ Types::DescribeConfigurationTemplatesResponse
Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see CreateDelivery.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1689 1690 1691 1692 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1689 def describe_configuration_templates(params = {}, = {}) req = build_request(:describe_configuration_templates, params) req.send_request() end |
#describe_deliveries(params = {}) ⇒ Types::DescribeDeliveriesResponse
Retrieves a list of the deliveries that have been created in the account.
A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1755 def describe_deliveries(params = {}, = {}) req = build_request(:describe_deliveries, params) req.send_request() end |
#describe_delivery_destinations(params = {}) ⇒ Types::DescribeDeliveryDestinationsResponse
Retrieves a list of the delivery destinations that have been created in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1801 1802 1803 1804 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1801 def describe_delivery_destinations(params = {}, = {}) req = build_request(:describe_delivery_destinations, params) req.send_request() end |
#describe_delivery_sources(params = {}) ⇒ Types::DescribeDeliverySourcesResponse
Retrieves a list of the delivery sources that have been created in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1848 1849 1850 1851 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1848 def describe_delivery_sources(params = {}, = {}) req = build_request(:describe_delivery_sources, params) req.send_request() 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.
1898 1899 1900 1901 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1898 def describe_destinations(params = {}, = {}) req = build_request(:describe_destinations, params) req.send_request() 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.
1956 1957 1958 1959 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 1956 def describe_export_tasks(params = {}, = {}) req = build_request(:describe_export_tasks, params) req.send_request() end |
#describe_log_groups(params = {}) ⇒ Types::DescribeLogGroupsResponse
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
CloudWatch Logs doesn't support IAM policies that control access to
the DescribeLogGroups
action by using the aws:ResourceTag/key-name
condition key. Other CloudWatch Logs actions do support the use of
the aws:ResourceTag/key-name
condition key to control access. For
more information about using tags to control access, see Controlling
access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2084 2085 2086 2087 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2084 def describe_log_groups(params = {}, = {}) req = build_request(:describe_log_groups, params) req.send_request() end |
#describe_log_streams(params = {}) ⇒ Types::DescribeLogStreamsResponse
Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
You can specify the log group to search by using either
logGroupIdentifier
or logGroupName
. You must include one of these
two parameters, but you can't include both.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2196 2197 2198 2199 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2196 def describe_log_streams(params = {}, = {}) req = build_request(:describe_log_streams, params) req.send_request() 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.
2269 2270 2271 2272 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2269 def describe_metric_filters(params = {}, = {}) req = build_request(:describe_metric_filters, params) req.send_request() end |
#describe_queries(params = {}) ⇒ Types::DescribeQueriesResponse
Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
2322 2323 2324 2325 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2322 def describe_queries(params = {}, = {}) req = build_request(:describe_queries, params) req.send_request() end |
#describe_query_definitions(params = {}) ⇒ Types::DescribeQueryDefinitionsResponse
This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account.
You can use the queryDefinitionNamePrefix
parameter to limit the
results to only the query definitions that have names that start with
a certain string.
2376 2377 2378 2379 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2376 def describe_query_definitions(params = {}, = {}) req = build_request(:describe_query_definitions, params) req.send_request() end |
#describe_resource_policies(params = {}) ⇒ Types::DescribeResourcePoliciesResponse
Lists the resource policies in this account.
2415 2416 2417 2418 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2415 def describe_resource_policies(params = {}, = {}) req = build_request(:describe_resource_policies, params) req.send_request() 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.
2471 2472 2473 2474 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2471 def describe_subscription_filters(params = {}, = {}) req = build_request(:describe_subscription_filters, params) req.send_request() end |
#disassociate_kms_key(params = {}) ⇒ Struct
Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use DisassociateKmsKey
, you specify either the
logGroupName
parameter or the resourceIdentifier
parameter. You
can't specify both of those parameters in the same operation.
Specify the
logGroupName
parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.Specify the
resourceIdentifier
parameter with thequery-result
resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
It can take up to 5 minutes for this operation to take effect.
2552 2553 2554 2555 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2552 def disassociate_kms_key(params = {}, = {}) req = build_request(:disassociate_kms_key, params) req.send_request() end |
#filter_log_events(params = {}) ⇒ Types::FilterLogEventsResponse
Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
You must have the logs:FilterLogEvents
permission to perform this
operation.
You can specify the log group to search by using either
logGroupIdentifier
or logGroupName
. You must include one of these
two parameters, but you can't include both.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp
when the event was ingested by CloudWatch Logs, and the ID of the
PutLogEvents
request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2708 2709 2710 2711 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2708 def filter_log_events(params = {}, = {}) req = build_request(:filter_log_events, params) req.send_request() end |
#get_data_protection_policy(params = {}) ⇒ Types::GetDataProtectionPolicyResponse
Returns information about a log group data protection policy.
2741 2742 2743 2744 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2741 def get_data_protection_policy(params = {}, = {}) req = build_request(:get_data_protection_policy, params) req.send_request() end |
#get_delivery(params = {}) ⇒ Types::GetDeliveryResponse
Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
You need to specify the delivery id
in this operation. You can find
the IDs of the deliveries in your account with the
DescribeDeliveries operation.
2799 2800 2801 2802 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2799 def get_delivery(params = {}, = {}) req = build_request(:get_delivery, params) req.send_request() end |
#get_delivery_destination(params = {}) ⇒ Types::GetDeliveryDestinationResponse
Retrieves complete information about one delivery destination.
2833 2834 2835 2836 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2833 def get_delivery_destination(params = {}, = {}) req = build_request(:get_delivery_destination, params) req.send_request() end |
#get_delivery_destination_policy(params = {}) ⇒ Types::GetDeliveryDestinationPolicyResponse
Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.
2869 2870 2871 2872 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2869 def get_delivery_destination_policy(params = {}, = {}) req = build_request(:get_delivery_destination_policy, params) req.send_request() end |
#get_delivery_source(params = {}) ⇒ Types::GetDeliverySourceResponse
Retrieves complete information about one delivery source.
2904 2905 2906 2907 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2904 def get_delivery_source(params = {}, = {}) req = build_request(:get_delivery_source, params) req.send_request() end |
#get_log_anomaly_detector(params = {}) ⇒ Types::GetLogAnomalyDetectorResponse
Retrieves information about the log anomaly detector that you specify.
2955 2956 2957 2958 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 2955 def get_log_anomaly_detector(params = {}, = {}) req = build_request(:get_log_anomaly_detector, params) req.send_request() end |
#get_log_events(params = {}) ⇒ Types::GetLogEventsResponse
Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either
logGroupIdentifier
or logGroupName
. You must include one of these
two parameters, but you can't include both.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3074 3075 3076 3077 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3074 def get_log_events(params = {}, = {}) req = build_request(:get_log_events, params) req.send_request() end |
#get_log_group_fields(params = {}) ⇒ Types::GetLogGroupFieldsResponse
Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either
logGroupIdentifier
or logGroupName
. You must specify one of these
parameters, but you can't specify both.
In the results, fields that start with @
are fields generated by
CloudWatch Logs. For example, @timestamp
is the timestamp of each
log event. For more information about the fields that are generated by
CloudWatch logs, see Supported Logs and Discovered Fields.
The response results are sorted by the frequency percentage, starting with the highest percentage.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
3155 3156 3157 3158 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3155 def get_log_group_fields(params = {}, = {}) req = build_request(:get_log_group_fields, params) req.send_request() 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
.
3201 3202 3203 3204 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3201 def get_log_record(params = {}, = {}) req = build_request(:get_log_record, params) req.send_request() end |
#get_query_results(params = {}) ⇒ Types::GetQueryResultsResponse
Returns the results from the specified query.
Only the fields requested in the query are returned, along with a
@ptr
field, which is the identifier for the log record. You can use
the value of @ptr
in a GetLogRecord operation to get the full
log record.
GetQueryResults
does not start running a query. To run a query, use
StartQuery. For more information about how long results of
previous queries are available, see CloudWatch Logs quotas.
If the value of the Status
field in the output is Running
, this
operation returns only partial results. If you see a value of
Scheduled
or Running
for the status, you can retry the operation
later to see the final results.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
3266 3267 3268 3269 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3266 def get_query_results(params = {}, = {}) req = build_request(:get_query_results, params) req.send_request() end |
#list_anomalies(params = {}) ⇒ Types::ListAnomaliesResponse
Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3345 3346 3347 3348 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3345 def list_anomalies(params = {}, = {}) req = build_request(:list_anomalies, params) req.send_request() end |
#list_log_anomaly_detectors(params = {}) ⇒ Types::ListLogAnomalyDetectorsResponse
Retrieves a list of the log anomaly detectors in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3399 3400 3401 3402 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3399 def list_log_anomaly_detectors(params = {}, = {}) req = build_request(:list_log_anomaly_detectors, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
3442 3443 3444 3445 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3442 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_tags_log_group(params = {}) ⇒ Types::ListTagsLogGroupResponse
The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
3478 3479 3480 3481 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3478 def (params = {}, = {}) req = build_request(:list_tags_log_group, params) req.send_request() end |
#put_account_policy(params = {}) ⇒ Types::PutAccountPolicyResponse
Creates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.
Data protection policy
A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.
Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.
If you use PutAccountPolicy
to create a data protection policy for
your whole account, it applies to both existing log groups and all log
groups that are created later in this account. The account-level
policy is applied to existing log groups with eventual consistency. It
might take up to 5 minutes before sensitive data in existing log
groups begins to be masked.
By default, when a user views a log event that includes masked data,
the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or
FilterLogEvents operation with the unmask
parameter set to
true
to view the unmasked log events. Users with the logs:Unmask
can also view unmasked data in the CloudWatch Logs console by running
a CloudWatch Logs Insights query with the unmask
query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
To use the PutAccountPolicy
operation for a data protection policy,
you must be signed on with the logs:PutDataProtectionPolicy
and
logs:PutAccountPolicy
permissions.
The PutAccountPolicy
operation applies to all log groups in the
account. You can use PutDataProtectionPolicy to create a data
protection policy that applies to just one log group. If a log group
has its own data protection policy and the account also has an
account-level data protection policy, then the two policies are
cumulative. Any sensitive term specified in either policy is masked.
Subscription filter policy
A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. 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 Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
An Firehose data stream in the same account as the subscription policy, for same-account delivery.
A Lambda function in the same account as the subscription policy, for same-account delivery.
A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
Each account can have one account-level subscription filter policy per
Region. If you are updating an existing filter, you must specify the
correct name in PolicyName
. To perform a PutAccountPolicy
subscription filter operation for any destination except a Lambda
function, you must also have the iam:PassRole
permission.
3705 3706 3707 3708 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3705 def put_account_policy(params = {}, = {}) req = build_request(:put_account_policy, params) req.send_request() end |
#put_data_protection_policy(params = {}) ⇒ Types::PutDataProtectionPolicyResponse
Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data,
the sensitive data is replaced by asterisks. A user who has the
logs:Unmask
permission can use a GetLogEvents or
FilterLogEvents operation with the unmask
parameter set to
true
to view the unmasked log events. Users with the logs:Unmask
can also view unmasked data in the CloudWatch Logs console by running
a CloudWatch Logs Insights query with the unmask
query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
The PutDataProtectionPolicy
operation applies to only the specified
log group. You can also use PutAccountPolicy to create an
account-level data protection policy that applies to all log groups in
the account, including both existing log groups and log groups that
are created level. If a log group has its own data protection policy
and the account also has an account-level data protection policy, then
the two policies are cumulative. Any sensitive term specified in
either policy is masked.
3814 3815 3816 3817 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3814 def put_data_protection_policy(params = {}, = {}) req = build_request(:put_data_protection_policy, params) req.send_request() end |
#put_delivery_destination(params = {}) ⇒ Types::PutDeliveryDestinationResponse
Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination.If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.
3917 3918 3919 3920 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3917 def put_delivery_destination(params = {}, = {}) req = build_request(:put_delivery_destination, params) req.send_request() end |
#put_delivery_destination_policy(params = {}) ⇒ Types::PutDeliveryDestinationPolicyResponse
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
Use this operation in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.
3984 3985 3986 3987 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 3984 def put_delivery_destination_policy(params = {}, = {}) req = build_request(:put_delivery_destination_policy, params) req.send_request() end |
#put_delivery_source(params = {}) ⇒ Types::PutDeliverySourceResponse
Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:
Use
PutDeliverySource
to create a delivery source, which is a logical object that represents the resource that is actually sending the logs.Use
PutDeliveryDestination
to create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use
CreateDelivery
to create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.
4098 4099 4100 4101 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4098 def put_delivery_source(params = {}, = {}) req = build_request(:put_delivery_source, params) req.send_request() end |
#put_destination(params = {}) ⇒ Types::PutDestinationResponse
Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
Through an access policy, a destination controls what is written to
it. By default, PutDestination
does not set any access policy with
the destination, which means a cross-account user cannot call
PutSubscriptionFilter against this destination. To enable this,
the destination owner must call PutDestinationPolicy after
PutDestination
.
To perform a PutDestination
operation, you must also have the
iam:PassRole
permission.
4176 4177 4178 4179 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4176 def put_destination(params = {}, = {}) req = build_request(:put_destination, params) req.send_request() 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.
4229 4230 4231 4232 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4229 def put_destination_policy(params = {}, = {}) req = build_request(:put_destination_policy, params) req.send_request() end |
#put_log_events(params = {}) ⇒ Types::PutLogEventsResponse
Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in PutLogEvents
actions.
PutLogEvents
actions are always accepted and never return
InvalidSequenceTokenException
or DataAlreadyAcceptedException
even
if the sequence token is not valid. You can use parallel
PutLogEvents
actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC
. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:yyyy-mm-ddThh:mm:ss
. For example,2017-09-15T13:45:30
.)A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
Each log event can be no larger than 256 KB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead,
PutLogEvents
actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to PutLogEvents
returns "UnrecognizedClientException"
the most likely cause is a non-valid Amazon Web Services access key ID
or secret key.
4339 4340 4341 4342 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4339 def put_log_events(params = {}, = {}) req = build_request(:put_log_events, params) req.send_request() end |
#put_metric_filter(params = {}) ⇒ Struct
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.
The maximum number of metric filters that can be associated with a log group is 100.
Using regular expressions to create metric filters is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in metric filters, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To
prevent unexpected high charges, do not specify high-cardinality
fields such as IPAddress
or requestID
as dimensions. Each
different value found for a dimension is treated as a separate metric
and accrues charges as a separate custom metric.
CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
4422 4423 4424 4425 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4422 def put_metric_filter(params = {}, = {}) req = build_request(:put_metric_filter, params) req.send_request() end |
#put_query_definition(params = {}) ⇒ Types::PutQueryDefinitionResponse
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId
in your
request. The values of name
, queryString
, and logGroupNames
are
changed to the values that you specify in your update operation. No
current values are retained from the current query definition. For
example, imagine updating a current query definition that includes log
groups. If you don't specify the logGroupNames
parameter in your
update operation, the query definition changes to contain no log
groups.
You must have the logs:PutQueryDefinition
permission to be able to
perform this operation.
4516 4517 4518 4519 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4516 def put_query_definition(params = {}, = {}) req = build_request(:put_query_definition, params) req.send_request() 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.
4582 4583 4584 4585 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4582 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#put_retention_policy(params = {}) ⇒ Struct
Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven't been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
When log events reach their retention setting they are marked for
deletion. After they are marked for deletion, they do not add to your
archival storage costs anymore, even if they are not actually deleted
until later. These log events marked for deletion are also not
included when you use an API to retrieve the storedBytes
value to
see how many bytes a log group is storing.
4642 4643 4644 4645 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4642 def put_retention_policy(params = {}, = {}) req = build_request(:put_retention_policy, params) req.send_request() end |
#put_subscription_filter(params = {}) ⇒ Struct
Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.
An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with
it. If you are updating an existing filter, you must specify the
correct name in filterName
.
Using regular expressions to create subscription filters is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in subscription filters, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
To perform a PutSubscriptionFilter
operation for any destination
except a Lambda function, you must also have the iam:PassRole
permission.
4761 4762 4763 4764 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 4761 def put_subscription_filter(params = {}, = {}) req = build_request(:put_subscription_filter, params) req.send_request() end |
#start_live_tail(params = {}) ⇒ Types::StartLiveTailResponse
Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.
The response to this operation is a response stream, over which the server sends live log events and the client receives them.
The following objects are sent over the stream:
A single LiveTailSessionStart object is sent at the start of the session.
Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array of the actual log events.
If no new log events were ingested in the past second, the
LiveTailSessionUpdate
object will contain an empty array.The array of log events contained in a
LiveTailSessionUpdate
can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in eachLiveTailSessionUpdate
object.If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10
LiveTailSessionUpdate
events or 5000 log events, after which it starts dropping the oldest events.A SessionStreamingException object is returned if an unknown error occurs on the server side.
A SessionTimeoutException object is returned when the session times out, after it has been kept open for three hours.
You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.
For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.
5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5030 def start_live_tail(params = {}, = {}) params = params.dup event_stream_handler = case handler = params.delete(:event_stream_handler) when EventStreams::StartLiveTailResponseStream then handler when Proc then EventStreams::StartLiveTailResponseStream.new.tap(&handler) when nil then EventStreams::StartLiveTailResponseStream.new else msg = "expected :event_stream_handler to be a block or "\ "instance of Aws::CloudWatchLogs::EventStreams::StartLiveTailResponseStream"\ ", got `#{handler.inspect}` instead" raise ArgumentError, msg end yield(event_stream_handler) if block_given? req = build_request(:start_live_tail, params) req.context[:event_stream_handler] = event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 95) req.send_request() end |
#start_query(params = {}) ⇒ Types::StartQueryResponse
Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
After you run a query using StartQuery
, the query results are stored
by CloudWatch Logs. You can use GetQueryResults to retrieve the
results of a query, using the queryId
that StartQuery
returns.
If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.
Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use
this operation in a monitoring account to start a query in a linked
source account. For more information, see CloudWatch cross-account
observability. For a cross-account StartQuery
operation, the
query definition must be defined in the monitoring account.
You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
5166 5167 5168 5169 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5166 def start_query(params = {}, = {}) req = build_request(:start_query, params) req.send_request() 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.
5197 5198 5199 5200 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5197 def stop_query(params = {}, = {}) req = build_request(:stop_query, params) req.send_request() end |
#tag_log_group(params = {}) ⇒ Struct
The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
CloudWatch Logs doesn't support IAM policies that prevent users from
assigning specified tags to log groups using the
aws:Resource/key-name
or aws:TagKeys
condition keys. For more
information about using tags to control access, see Controlling
access to Amazon Web Services resources using tags.
5248 5249 5250 5251 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5248 def tag_log_group(params = {}, = {}) req = build_request(:tag_log_group, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource
action with a resource that already has
tags. If you specify a new tag key for the alarm, this tag is appended
to the list of tags associated with the alarm. If you specify a tag
key that is already associated with the alarm, the new tag value that
you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch Logs resource.
5306 5307 5308 5309 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5306 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() 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.
5347 5348 5349 5350 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5347 def test_metric_filter(params = {}, = {}) req = build_request(:test_metric_filter, params) req.send_request() end |
#untag_log_group(params = {}) ⇒ Struct
The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn't support IAM policies that prevent users from
assigning specified tags to log groups using the
aws:Resource/key-name
or aws:TagKeys
condition keys.
5389 5390 5391 5392 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5389 def untag_log_group(params = {}, = {}) req = build_request(:untag_log_group, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
5429 5430 5431 5432 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5429 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_anomaly(params = {}) ⇒ Struct
Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern.
You must specify either anomalyId
or patternId
, but you can't
specify both parameters in the same operation.
If you have previously used this operation to suppress detection of a
pattern or anomaly, you can use it again to cause CloudWatch Logs to
end the suppression. To do this, use this operation and specify the
anomaly or pattern to stop suppressing, and omit the suppressionType
and suppressionPeriod
parameters.
5509 5510 5511 5512 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5509 def update_anomaly(params = {}, = {}) req = build_request(:update_anomaly, params) req.send_request() end |
#update_delivery_configuration(params = {}) ⇒ Struct
Use this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs. You can't use this operation to change the source or destination of the delivery.
5557 5558 5559 5560 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5557 def update_delivery_configuration(params = {}, = {}) req = build_request(:update_delivery_configuration, params) req.send_request() end |
#update_log_anomaly_detector(params = {}) ⇒ Struct
Updates an existing log anomaly detector.
5607 5608 5609 5610 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/client.rb', line 5607 def update_log_anomaly_detector(params = {}, = {}) req = build_request(:update_log_anomaly_detector, params) req.send_request() end |