aws_logs

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

You can use CloudWatch Logs to:

• Monitor logs from EC2 instances in real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.

• Monitor AWS CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.

• Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

Summary

Functions

• associate_kms_key(Client, Input)
  Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
• associate_kms_key(Client, Input, Options)
• cancel_export_task(Client, Input)
  Cancels the specified export task.
• cancel_export_task(Client, Input, Options)
• create_export_task(Client, Input)
  Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.
• create_export_task(Client, Input, Options)
• create_log_group(Client, Input)
  Creates a log group with the specified name.
• create_log_group(Client, Input, Options)
• create_log_stream(Client, Input)
  Creates a log stream for the specified log group.
• create_log_stream(Client, Input, Options)
• delete_destination(Client, Input)
  Deletes the specified destination, and eventually disables all the subscription filters that publish to it.
• delete_destination(Client, Input, Options)
• delete_log_group(Client, Input)
  Deletes the specified log group and permanently deletes all the archived log events associated with the log group.
• delete_log_group(Client, Input, Options)
• delete_log_stream(Client, Input)
  Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.
• delete_log_stream(Client, Input, Options)
• delete_metric_filter(Client, Input)
  Deletes the specified metric filter.
• delete_metric_filter(Client, Input, Options)
• delete_query_definition(Client, Input)
• delete_query_definition(Client, Input, Options)
• delete_resource_policy(Client, Input)
  Deletes a resource policy from this account.
• delete_resource_policy(Client, Input, Options)
• delete_retention_policy(Client, Input)
  Deletes the specified retention policy.
• delete_retention_policy(Client, Input, Options)
• delete_subscription_filter(Client, Input)
  Deletes the specified subscription filter.
• delete_subscription_filter(Client, Input, Options)
• describe_destinations(Client, Input)
  Lists all your destinations.
• describe_destinations(Client, Input, Options)
• describe_export_tasks(Client, Input)
  Lists the specified export tasks.
• describe_export_tasks(Client, Input, Options)
• describe_log_groups(Client, Input)
  Lists the specified log groups.
• describe_log_groups(Client, Input, Options)
• describe_log_streams(Client, Input)
  Lists the log streams for the specified log group.
• describe_log_streams(Client, Input, Options)
• describe_metric_filters(Client, Input)
  Lists the specified metric filters.
• describe_metric_filters(Client, Input, Options)
• describe_queries(Client, Input)
  Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account.
• describe_queries(Client, Input, Options)
• describe_query_definitions(Client, Input)
• describe_query_definitions(Client, Input, Options)
• describe_resource_policies(Client, Input)
  Lists the resource policies in this account.
• describe_resource_policies(Client, Input, Options)
• describe_subscription_filters(Client, Input)
  Lists the subscription filters for the specified log group.
• describe_subscription_filters(Client, Input, Options)
• disassociate_kms_key(Client, Input)
  Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.
• disassociate_kms_key(Client, Input, Options)
• filter_log_events(Client, Input)
  Lists log events from the specified log group.
• filter_log_events(Client, Input, Options)
• get_log_events(Client, Input)
  Lists log events from the specified log stream.
• get_log_events(Client, Input, Options)
• get_log_group_fields(Client, Input)
  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.
• get_log_group_fields(Client, Input, Options)
• get_log_record(Client, Input)
  Retrieves all the fields and values of a single log event.
• get_log_record(Client, Input, Options)
• get_query_results(Client, Input)
  Returns the results from the specified query.
• get_query_results(Client, Input, Options)
• list_tags_log_group(Client, Input)
  Lists the tags for the specified log group.
• list_tags_log_group(Client, Input, Options)
• put_destination(Client, Input)
  Creates or updates a destination.
• put_destination(Client, Input, Options)
• put_destination_policy(Client, Input)
  Creates or updates an access policy associated with an existing destination.
• put_destination_policy(Client, Input, Options)
• put_log_events(Client, Input)
  Uploads a batch of log events to the specified log stream.
• put_log_events(Client, Input, Options)
• put_metric_filter(Client, Input)
  Creates or updates a metric filter and associates it with the specified log group.
• put_metric_filter(Client, Input, Options)
• put_query_definition(Client, Input)
• put_query_definition(Client, Input, Options)
• put_resource_policy(Client, Input)
  Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53.
• put_resource_policy(Client, Input, Options)
• put_retention_policy(Client, Input)
  Sets the retention of the specified log group.
• put_retention_policy(Client, Input, Options)
• put_subscription_filter(Client, Input)
  Creates or updates a subscription filter and associates it with the specified log group.
• put_subscription_filter(Client, Input, Options)
• start_query(Client, Input)
  Schedules a query of a log group using CloudWatch Logs Insights.
• start_query(Client, Input, Options)
• stop_query(Client, Input)
  Stops a CloudWatch Logs Insights query that is in progress.
• stop_query(Client, Input, Options)
• tag_log_group(Client, Input)
  Adds or updates the specified tags for the specified log group.
• tag_log_group(Client, Input, Options)
• test_metric_filter(Client, Input)
  Tests the filter pattern of a metric filter against a sample of log event messages.
• test_metric_filter(Client, Input, Options)
• untag_log_group(Client, Input)
  Removes the specified tags from the specified log group.
• untag_log_group(Client, Input, Options)

Functions

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.

Important: CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For more information, see Using Symmetric and Asymmetric Keys. Note that it can take up to 5 minutes for this operation to take effect.

Cancels the specified export task.

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.

Creates a log group with the specified name.

You can create up to 20,000 log groups per account.

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

• Log group names must be unique within a region for an 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), '.' (period), and '#' (number sign)

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.

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. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.

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

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

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

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

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.

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

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

Deletes the specified metric filter.

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

Deletes the specified retention policy.

Deletes the specified subscription filter.

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

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

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.

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.

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.

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.

Lists the resource policies in this account.

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.

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.

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.

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

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

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

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.

Returns the results from the specified query.

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

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

Lists the tags for the specified log group.

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

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

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.

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

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls 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 older than 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.)

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

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

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

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.

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.

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.

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.

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.

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.

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.

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.

Removes the specified tags from the specified log group.