NAME

Paws::CloudWatchLogs - Perl Interface to AWS Amazon CloudWatch Logs

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CloudWatchLogs');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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

You can use CloudWatch Logs to:

  • Monitor Logs from Amazon 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 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 Amazon CloudWatch metric that you specify.

  • Monitor Amazon CloudTrail Logged Events: You can create alarms in Amazon 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.

METHODS

CancelExportTask(TaskId => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::CancelExportTask

Returns: nothing

  Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

CreateExportTask(Destination => Str, From => Int, LogGroupName => Str, To => Int, [DestinationPrefix => Str, LogStreamNamePrefix => Str, TaskName => Str])

Each argument is described in detail in: Paws::CloudWatchLogs::CreateExportTask

Returns: a Paws::CloudWatchLogs::CreateExportTaskResponse instance

  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 that will be used as the Amazon S3 key prefix for all exported objects.

CreateLogGroup(LogGroupName => Str, [Tags => Paws::CloudWatchLogs::Tags])

Each argument is described in detail in: Paws::CloudWatchLogs::CreateLogGroup

Returns: nothing

  Creates a log group with the specified name.

You can create up to 5000 log groups per account.

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

  • Log group names must be unique within a region for an AWS account.

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

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

CreateLogStream(LogGroupName => Str, LogStreamName => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::CreateLogStream

Returns: nothing

  Creates a log stream for the specified log group.

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

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

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

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

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

DeleteDestination(DestinationName => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::DeleteDestination

Returns: nothing

  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.

DeleteLogGroup(LogGroupName => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::DeleteLogGroup

Returns: nothing

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

DeleteLogStream(LogGroupName => Str, LogStreamName => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::DeleteLogStream

Returns: nothing

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

DeleteMetricFilter(FilterName => Str, LogGroupName => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::DeleteMetricFilter

Returns: nothing

  Deletes the specified metric filter.

DeleteRetentionPolicy(LogGroupName => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::DeleteRetentionPolicy

Returns: nothing

  Deletes the specified retention policy.

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

DeleteSubscriptionFilter(FilterName => Str, LogGroupName => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::DeleteSubscriptionFilter

Returns: nothing

  Deletes the specified subscription filter.

DescribeDestinations([DestinationNamePrefix => Str, Limit => Int, NextToken => Str])

Each argument is described in detail in: Paws::CloudWatchLogs::DescribeDestinations

Returns: a Paws::CloudWatchLogs::DescribeDestinationsResponse instance

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

DescribeExportTasks([Limit => Int, NextToken => Str, StatusCode => Str, TaskId => Str])

Each argument is described in detail in: Paws::CloudWatchLogs::DescribeExportTasks

Returns: a Paws::CloudWatchLogs::DescribeExportTasksResponse instance

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

DescribeLogGroups([Limit => Int, LogGroupNamePrefix => Str, NextToken => Str])

Each argument is described in detail in: Paws::CloudWatchLogs::DescribeLogGroups

Returns: a Paws::CloudWatchLogs::DescribeLogGroupsResponse instance

  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.

DescribeLogStreams(LogGroupName => Str, [Descending => Bool, Limit => Int, LogStreamNamePrefix => Str, NextToken => Str, OrderBy => Str])

Each argument is described in detail in: Paws::CloudWatchLogs::DescribeLogStreams

Returns: a Paws::CloudWatchLogs::DescribeLogStreamsResponse instance

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

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

DescribeMetricFilters([FilterNamePrefix => Str, Limit => Int, LogGroupName => Str, MetricName => Str, MetricNamespace => Str, NextToken => Str])

Each argument is described in detail in: Paws::CloudWatchLogs::DescribeMetricFilters

Returns: a Paws::CloudWatchLogs::DescribeMetricFiltersResponse instance

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

DescribeSubscriptionFilters(LogGroupName => Str, [FilterNamePrefix => Str, Limit => Int, NextToken => Str])

Each argument is described in detail in: Paws::CloudWatchLogs::DescribeSubscriptionFilters

Returns: a Paws::CloudWatchLogs::DescribeSubscriptionFiltersResponse instance

  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.

FilterLogEvents(LogGroupName => Str, [EndTime => Int, FilterPattern => Str, Interleaved => Bool, Limit => Int, LogStreamNames => ArrayRef[Str|Undef], NextToken => Str, StartTime => Int])

Each argument is described in detail in: Paws::CloudWatchLogs::FilterLogEvents

Returns: a Paws::CloudWatchLogs::FilterLogEventsResponse instance

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

By default, this operation returns as many log events as can fit in 1MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

GetLogEvents(LogGroupName => Str, LogStreamName => Str, [EndTime => Int, Limit => Int, NextToken => Str, StartFromHead => Bool, StartTime => Int])

Each argument is described in detail in: Paws::CloudWatchLogs::GetLogEvents

Returns: a Paws::CloudWatchLogs::GetLogEventsResponse instance

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

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

ListTagsLogGroup(LogGroupName => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::ListTagsLogGroup

Returns: a Paws::CloudWatchLogs::ListTagsLogGroupResponse instance

  Lists the tags for the specified log group.

To add tags, use TagLogGroup. To remove tags, use UntagLogGroup.

PutDestination(DestinationName => Str, RoleArn => Str, TargetArn => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::PutDestination

Returns: a Paws::CloudWatchLogs::PutDestinationResponse instance

  Creates or updates a destination. A destination encapsulates a physical
resource (such as a Kinesis stream) and enables you to subscribe to a
real-time stream of log events of a different account, ingested using
PutLogEvents. Currently, the only supported physical resource is a
Amazon Kinesis stream belonging to the same account as the destination.

A destination controls what is written to its Amazon Kinesis stream through an access policy. 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.

PutDestinationPolicy(AccessPolicy => Str, DestinationName => Str)

Each argument is described in detail in: Paws::CloudWatchLogs::PutDestinationPolicy

Returns: nothing

  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.

PutLogEvents(LogEvents => ArrayRef[Paws::CloudWatchLogs::InputLogEvent], LogGroupName => Str, LogStreamName => Str, [SequenceToken => Str])

Each argument is described in detail in: Paws::CloudWatchLogs::PutLogEvents

Returns: a Paws::CloudWatchLogs::PutLogEventsResponse instance

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

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams.

The batch of events must satisfy the following constraints:

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

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

  • None of the log events in the batch can be older than 14 days or the retention period of the log group.

  • The log events in the batch must be in chronological ordered by their timestamp (the time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC).

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

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

PutMetricFilter(FilterName => Str, FilterPattern => Str, LogGroupName => Str, MetricTransformations => ArrayRef[Paws::CloudWatchLogs::MetricTransformation])

Each argument is described in detail in: Paws::CloudWatchLogs::PutMetricFilter

Returns: nothing

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

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

PutRetentionPolicy(LogGroupName => Str, RetentionInDays => Int)

Each argument is described in detail in: Paws::CloudWatchLogs::PutRetentionPolicy

Returns: nothing

  Sets the retention of the specified log group. A retention policy
allows you to configure the number of days you want to retain log
events in the specified log group.

PutSubscriptionFilter(DestinationArn => Str, FilterName => Str, FilterPattern => Str, LogGroupName => Str, [Distribution => Str, RoleArn => Str])

Each argument is described in detail in: Paws::CloudWatchLogs::PutSubscriptionFilter

Returns: nothing

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

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

There can only be one subscription filter associated with a log group.

TagLogGroup(LogGroupName => Str, Tags => Paws::CloudWatchLogs::Tags)

Each argument is described in detail in: Paws::CloudWatchLogs::TagLogGroup

Returns: nothing

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

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

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

TestMetricFilter(FilterPattern => Str, LogEventMessages => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::CloudWatchLogs::TestMetricFilter

Returns: a Paws::CloudWatchLogs::TestMetricFilterResponse instance

  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.

UntagLogGroup(LogGroupName => Str, Tags => ArrayRef[Str|Undef])

Each argument is described in detail in: Paws::CloudWatchLogs::UntagLogGroup

Returns: nothing

  Removes the specified tags from the specified log group.

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

DescribeAllDestinations(sub { },[DestinationNamePrefix => Str, Limit => Int, NextToken => Str])

DescribeAllDestinations([DestinationNamePrefix => Str, Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - destinations, passing the object as the first parameter, and the string 'destinations' as the second parameter 

If not, it will return a a Paws::CloudWatchLogs::DescribeDestinationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllLogGroups(sub { },[Limit => Int, LogGroupNamePrefix => Str, NextToken => Str])

DescribeAllLogGroups([Limit => Int, LogGroupNamePrefix => Str, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - logGroups, passing the object as the first parameter, and the string 'logGroups' as the second parameter 

If not, it will return a a Paws::CloudWatchLogs::DescribeLogGroupsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllLogStreams(sub { },LogGroupName => Str, [Descending => Bool, Limit => Int, LogStreamNamePrefix => Str, NextToken => Str, OrderBy => Str])

DescribeAllLogStreams(LogGroupName => Str, [Descending => Bool, Limit => Int, LogStreamNamePrefix => Str, NextToken => Str, OrderBy => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - logStreams, passing the object as the first parameter, and the string 'logStreams' as the second parameter 

If not, it will return a a Paws::CloudWatchLogs::DescribeLogStreamsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllMetricFilters(sub { },[FilterNamePrefix => Str, Limit => Int, LogGroupName => Str, MetricName => Str, MetricNamespace => Str, NextToken => Str])

DescribeAllMetricFilters([FilterNamePrefix => Str, Limit => Int, LogGroupName => Str, MetricName => Str, MetricNamespace => Str, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - metricFilters, passing the object as the first parameter, and the string 'metricFilters' as the second parameter 

If not, it will return a a Paws::CloudWatchLogs::DescribeMetricFiltersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllSubscriptionFilters(sub { },LogGroupName => Str, [FilterNamePrefix => Str, Limit => Int, NextToken => Str])

DescribeAllSubscriptionFilters(LogGroupName => Str, [FilterNamePrefix => Str, Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - subscriptionFilters, passing the object as the first parameter, and the string 'subscriptionFilters' as the second parameter 

If not, it will return a a Paws::CloudWatchLogs::DescribeSubscriptionFiltersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

FilterAllLogEvents(sub { },LogGroupName => Str, [EndTime => Int, FilterPattern => Str, Interleaved => Bool, Limit => Int, LogStreamNames => ArrayRef[Str|Undef], NextToken => Str, StartTime => Int])

FilterAllLogEvents(LogGroupName => Str, [EndTime => Int, FilterPattern => Str, Interleaved => Bool, Limit => Int, LogStreamNames => ArrayRef[Str|Undef], NextToken => Str, StartTime => Int])

If passed a sub as first parameter, it will call the sub for each element found in :

 - events, passing the object as the first parameter, and the string 'events' as the second parameter 

 - searchedLogStreams, passing the object as the first parameter, and the string 'searchedLogStreams' as the second parameter 

If not, it will return a a Paws::CloudWatchLogs::FilterLogEventsResponse instance with all the params; andparams; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues