|
NAMEPaws::CloudWatchLogs - Perl Interface to AWS Amazon CloudWatch LogsSYNOPSISuse 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' } ], ); DESCRIPTIONAmazon CloudWatch Logs API ReferenceThis 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:
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.
Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:
METHODSCreateLogGroup(logGroupName => Str)Each argument is described in detail in: Paws::CloudWatchLogs::CreateLogGroupReturns: 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:
CreateLogStream(logGroupName => Str, logStreamName => Str)Each argument is described in detail in: Paws::CloudWatchLogs::CreateLogStreamReturns: 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:
DeleteDestination(destinationName => Str)Each argument is described in detail in: Paws::CloudWatchLogs::DeleteDestinationReturns: nothing Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination. DeleteLogGroup(logGroupName => Str)Each argument is described in detail in: Paws::CloudWatchLogs::DeleteLogGroupReturns: 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::DeleteLogStreamReturns: 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::DeleteMetricFilterReturns: nothing Deletes a metric filter associated with the specified log group. DeleteRetentionPolicy(logGroupName => Str)Each argument is described in detail in: Paws::CloudWatchLogs::DeleteRetentionPolicyReturns: 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. DeleteSubscriptionFilter(filterName => Str, logGroupName => Str)Each argument is described in detail in: Paws::CloudWatchLogs::DeleteSubscriptionFilterReturns: nothing Deletes a subscription filter associated with the specified log group. DescribeDestinations([DestinationNamePrefix => Str, limit => Int, nextToken => Str])Each argument is described in detail in: Paws::CloudWatchLogs::DescribeDestinationsReturns: a Paws::CloudWatchLogs::DescribeDestinationsResponse instance Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name. By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a "nextToken" value in the response body. You can also limit the number of destinations returned in the response by specifying the "limit" parameter in the request. DescribeLogGroups([limit => Int, logGroupNamePrefix => Str, nextToken => Str])Each argument is described in detail in: Paws::CloudWatchLogs::DescribeLogGroupsReturns: 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::DescribeLogStreamsReturns: 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::DescribeMetricFiltersReturns: 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. DescribeSubscriptionFilters(logGroupName => Str, [filterNamePrefix => Str, limit => Int, nextToken => Str])Each argument is described in detail in: Paws::CloudWatchLogs::DescribeSubscriptionFiltersReturns: a Paws::CloudWatchLogs::DescribeSubscriptionFiltersResponse instance Returns all the subscription 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 subscription filters. If there are more subscription filters to list, the response would contain a "nextToken" value in the response body. You can also limit the number of subscription filters returned in the response by specifying the "limit" parameter in the request. FilterLogEvents(logGroupName => Str, [endTime => Int, filterPattern => Str, interleaved => Bool, limit => Int, logStreamNames => ArrayRef[Str], nextToken => Str, startTime => Int])Each argument is described in detail in: Paws::CloudWatchLogs::FilterLogEventsReturns: a Paws::CloudWatchLogs::FilterLogEventsResponse instance Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event "timestamp". You can limit the streams searched to an explicit list of "logStreamNames". By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a "nextToken", then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of "searchedLogStreams" that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The "limit" parameter in the request. can be used to specify the maximum number of events to return in a page. GetLogEvents(logGroupName => Str, logStreamName => Str, [endTime => Int, limit => Int, nextToken => Str, startFromHead => Bool, startTime => Int])Each argument is described in detail in: Paws::CloudWatchLogs::GetLogEventsReturns: 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. PutDestination(destinationName => Str, roleArn => Str, targetArn => Str)Each argument is described in detail in: Paws::CloudWatchLogs::PutDestinationReturns: a Paws::CloudWatchLogs::PutDestinationResponse instance Creates or updates a "Destination". A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through "PutLogEvents" requests. 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 will not be able to call "PutSubscriptionFilter" against this destination. To enable that, the destination owner must call "PutDestinationPolicy" after PutDestination. PutDestinationPolicy(accessPolicy => Str, destinationName => Str)Each argument is described in detail in: Paws::CloudWatchLogs::PutDestinationPolicyReturns: 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::PutLogEventsReturns: 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:
PutMetricFilter(filterName => Str, filterPattern => Str, logGroupName => Str, metricTransformations => ArrayRef[Paws::CloudWatchLogs::MetricTransformation])Each argument is described in detail in: Paws::CloudWatchLogs::PutMetricFilterReturns: 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. 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::PutRetentionPolicyReturns: 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, [roleArn => Str])Each argument is described in detail in: Paws::CloudWatchLogs::PutSubscriptionFilterReturns: 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" requests and have them delivered to a specific destination. Currently, the supported destinations are:
Currently there can only be one subscription filter associated with a log group. TestMetricFilter(filterPattern => Str, logEventMessages => ArrayRef[Str])Each argument is described in detail in: Paws::CloudWatchLogs::TestMetricFilterReturns: 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 ALSOThis service class forms part of PawsBUGS and CONTRIBUTIONSThe source code is located here: https://github.com/pplu/aws-sdk-perlPlease report bugs to: https://github.com/pplu/aws-sdk-perl/issues
Visit the GSP FreeBSD Man Page Interface. |