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:
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:
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": "Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.
", "DeleteLogStream": "Deletes a log stream and permanently deletes all the archived log events associated with it.
", "DeleteMetricFilter": "Deletes a metric filter associated with the specified log group.
", "DeleteRetentionPolicy": "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": "Deletes a subscription filter associated with the specified log group.
", + "DescribeDestinations": "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.
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.
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.
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.
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.
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.
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.
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.
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.
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:
timestamp. 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": "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": " 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 only supported destination is an Amazon Kinesis stream belonging to the same account as the subscription filter.
Currently there can only be one subscription filter associated with a log group.
", + "PutSubscriptionFilter": " 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:
Destination) belonging to a different account, for cross-account delivery. Currently there can only be one subscription filter associated with a log group.
", "TestMetricFilter": "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.
" }, "service": "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:
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:
An IAM policy document that authorizes cross-account users to deliver their log events to associated destination.
" + } + }, "Arn": { "base": null, "refs": { + "Destination$arn": null, "LogGroup$arn": null, "LogStream$arn": null } @@ -51,6 +63,11 @@ "PutRetentionPolicyRequest$retentionInDays": null } }, + "DeleteDestinationRequest": { + "base": null, + "refs": { + } + }, "DeleteLogGroupRequest": { "base": null, "refs": { @@ -82,9 +99,20 @@ "DescribeLogStreamsRequest$descending": "If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.
" } }, + "DescribeDestinationsRequest": { + "base": null, + "refs": { + } + }, + "DescribeDestinationsResponse": { + "base": null, + "refs": { + } + }, "DescribeLimit": { "base": "The maximum number of results to return.
", "refs": { + "DescribeDestinationsRequest$limit": null, "DescribeLogGroupsRequest$limit": "The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
", "DescribeLogStreamsRequest$limit": "The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
", "DescribeMetricFiltersRequest$limit": "The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
", @@ -131,13 +159,36 @@ "refs": { } }, + "Destination": { + "base": null, + "refs": { + "Destinations$member": null, + "PutDestinationResponse$destination": null + } + }, "DestinationArn": { "base": null, "refs": { - "PutSubscriptionFilterRequest$destinationArn": "The ARN of an Amazon Kinesis stream to deliver matching log events to.
", + "PutSubscriptionFilterRequest$destinationArn": "The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
Destination) belonging to a different account, for cross-account delivery. The name of destination to delete.
", + "DescribeDestinationsRequest$DestinationNamePrefix": "Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.
", + "Destination$destinationName": null, + "PutDestinationPolicyRequest$destinationName": "A name for an existing destination.
", + "PutDestinationRequest$destinationName": "A name for the destination.
" + } + }, + "Destinations": { + "base": null, + "refs": { + "DescribeDestinationsResponse$destinations": null + } + }, "EventId": { "base": null, "refs": { @@ -408,6 +459,8 @@ "NextToken": { "base": "A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous request. The token expires after 24 hours.
", "refs": { + "DescribeDestinationsRequest$nextToken": null, + "DescribeDestinationsResponse$nextToken": null, "DescribeLogGroupsRequest$nextToken": " A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogGroups request.
A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.
", + "Destination$roleArn": null, + "PutDestinationRequest$roleArn": "The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.
", + "PutSubscriptionFilterRequest$roleArn": "The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination (used via an ARN of Destination) for cross-account delivery.
The ARN of an Amazon Kinesis stream to deliver matching log events to.
" + } + }, "TestEventMessages": { "base": null, "refs": { @@ -565,6 +642,7 @@ "Timestamp": { "base": "A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
", "refs": { + "Destination$creationTime": null, "FilterLogEventsRequest$startTime": "A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.
", "FilterLogEventsRequest$endTime": "A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.
", "FilteredLogEvent$timestamp": null,