The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.04
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::CloudWatchLogs

NAME

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

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CloudWatchLogs')->new;
  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

Amazon CloudWatch Logs API Reference

This is the Amazon CloudWatch Logs API Reference. Amazon CloudWatch Logs enables you to monitor, store, and access your system, application, and custom log files. This guide provides detailed information about Amazon CloudWatch Logs actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch Logs features and their associated API calls, go to the Amazon CloudWatch Developer Guide.

Use the following links to get started using the Amazon CloudWatch Logs API Reference:

  • Actions: An alphabetical list of all Amazon CloudWatch Logs actions.

  • Data Types: An alphabetical list of all Amazon CloudWatch Logs data types.

  • Common Parameters: Parameters that all Query actions can use.

  • Common Errors: Client and server errors that all actions can return.

  • Regions and Endpoints: Itemized regions and endpoints for all AWS products.

In addition to using the Amazon CloudWatch Logs API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch Logs programmatically.

  • AWS SDK for Java Documentation

  • AWS SDK for .NET Documentation

  • AWS SDK for PHP Documentation

  • AWS SDK for Ruby Documentation

Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:

  • AWS Java Developer Center

  • AWS PHP Developer Center

  • AWS Python Developer Center

  • AWS Ruby Developer Center

  • AWS Windows and .NET Developer Center

METHODS

CreateLogGroup(logGroupName => Str)

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

Returns: nothing

Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account.

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

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

  • Allowed characters are 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 new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group.

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

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

  • The ':' colon character is not allowed.

DeleteLogGroup(logGroupName => Str)

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

Returns: nothing

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

DeleteLogStream(logGroupName => Str, logStreamName => Str)

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

Returns: nothing

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

DeleteMetricFilter(filterName => Str, logGroupName => Str)

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

Returns: nothing

Deletes a metric filter associated with the specified log group.

DeleteRetentionPolicy(logGroupName => Str)

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

Returns: nothing

Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.

DescribeLogGroups([limit => Int, logGroupNamePrefix => Str, nextToken => Str])

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

Returns: a Paws::CloudWatchLogs::DescribeLogGroupsResponse instance

Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name.

By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a nextToken value in the response body. You can also limit the number of log groups returned in the response by specifying the limit parameter in the request.

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

Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled.

DescribeMetricFilters(logGroupName => Str, [filterNamePrefix => Str, limit => Int, nextToken => Str])

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

Returns: a Paws::CloudWatchLogs::DescribeMetricFiltersResponse instance

Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.

GetLogEvents(logGroupName => Str, logStreamName => Str, [endTime => Num, limit => Int, nextToken => Str, startFromHead => Bool, startTime => Num])

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

Returns: a Paws::CloudWatchLogs::GetLogEventsResponse instance

Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp.

By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

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.

Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken.

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 maximum number of log events in a batch is 10,000.

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

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.

TestMetricFilter(filterPattern => Str, logEventMessages => ArrayRef[Str])

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.

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