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

For the AWS API documentation, see https://docs.aws.amazon.com/cloudwatch/

METHODS

AssociateKmsKey

KmsKeyId => Str
LogGroupName => Str

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

Returns: nothing

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

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

Note that it can take up to 5 minutes for this operation to take effect.

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

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

CreateLogGroup

LogGroupName => Str
[KmsKeyId => 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).

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.

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.

DeleteResourcePolicy

[PolicyName => Str]

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

Returns: nothing

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

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

DescribeQueries

[LogGroupName => Str]
[MaxResults => Int]
[NextToken => Str]
[Status => Str]

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

Returns: a Paws::CloudWatchLogs::DescribeQueriesResponse instance

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.

DescribeResourcePolicies

[Limit => Int]
[NextToken => Str]

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

Returns: a Paws::CloudWatchLogs::DescribeResourcePoliciesResponse instance

Lists the resource policies in this account.

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.

DisassociateKmsKey

LogGroupName => Str

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

Returns: nothing

Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

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

Note that it can take up to 5 minutes for this operation to take effect.

FilterLogEvents

LogGroupName => Str
[EndTime => Int]
[FilterPattern => Str]
[Interleaved => Bool]
[Limit => Int]
[LogStreamNamePrefix => Str]
[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 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

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). You can get additional log events by specifying one of the tokens in a subsequent call.

GetLogGroupFields

LogGroupName => Str
[Time => Int]

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

Returns: a Paws::CloudWatchLogs::GetLogGroupFieldsResponse instance

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

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event.

The response results are sorted by the frequency percentage, starting with the highest percentage.

GetLogRecord

LogRecordPointer => Str

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

Returns: a Paws::CloudWatchLogs::GetLogRecordResponse instance

Retrieves all the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

Additionally, the entire unparsed log event is returned within @message.

GetQueryResults

QueryId => Str

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

Returns: a Paws::CloudWatchLogs::GetQueryResultsResponse instance

Returns the results from the specified query. If the query is in progress, partial results of that current execution are returned. Only the fields requested in the query are returned.

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

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.

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 an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.

Through an access policy, a destination controls what is written to its Kinesis stream. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

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 (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html) 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. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

The batch of events must satisfy the following constraints:

The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be older than 14 days or the retention period of the log group.
The log events in the batch must be in chronological ordered by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
The maximum number of log events in a batch is 10,000.
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.

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.

PutResourcePolicy

[PolicyDocument => Str]
[PolicyName => Str]

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

Returns: a Paws::CloudWatchLogs::PutResourcePolicyResponse instance

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.

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

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

StartQuery

EndTime => Int
LogGroupName => Str
QueryString => Str
StartTime => Int
[Limit => Int]

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

Returns: a Paws::CloudWatchLogs::StartQueryResponse instance

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group to query, the query string to use, and the time to query.

For more information, see CloudWatch Logs Insights Query Syntax (http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).

StopQuery

QueryId => Str

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

Returns: a Paws::CloudWatchLogs::StopQueryResponse instance

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.

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 (http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/log-group-tagging.html) 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