Data retrieval APIs for Amazon CloudWatch Logs
Amazon CloudWatch Logs provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| DescribeAccountPolicies | Retrieve account policies | List |
| DescribeConfigurationTemplates | Retrieve a list of configuration templates of available log types | List |
| DescribeDeliveries | Retrieve a list of deliveries an account | List |
| DescribeDeliveryDestinations | Retrieve a list of delivery destinations an account | List |
| DescribeDeliverySources | Retrieve a list of delivery sources in an account | List |
| DescribeDestinations | Return all the destinations that are associated with the AWS account making the request | List |
| DescribeExportTasks | Return all the export tasks that are associated with the AWS account making the request | List |
| DescribeFieldIndexes | Return all the indexing attributes that are attached with the log groups | List |
| DescribeImportTaskBatches | Return detailed information about the individual batches within an import task, including status and any error | List |
| DescribeImportTasks | Return all the import tasks associated with the AWS account making the request | List |
| DescribeIndexPolicies | Return all the index policies that are attached with the log groups | List |
| DescribeLogGroups | Return all the log groups that are associated with the AWS account making the request | List |
| DescribeLogStreams | Return all the log streams that are associated with the specified log group | List |
| DescribeLookupTables | Return all lookup tables | List |
| DescribeMetricFilters | Return all the metrics filters associated with the specified log group | List |
| DescribeQueries | Return a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account | List |
| DescribeQueryDefinitions | Return a paginated list of your saved CloudWatch Logs Insights query definitions | List |
| DescribeResourcePolicies | Return all the resource policies in this account | List |
| DescribeSubscriptionFilters | Return all the subscription filters associated with the specified log group | List |
| FilterLogEvents | Retrieve log events, optionally filtered by a filter pattern from the specified log group | Read |
| GetDataProtectionPolicy | Retrieve a data protection policy attached to a log group | Read |
| GetDelivery | Retrieve a single delivery | Read |
| GetDeliveryDestination | Retrieve a single delivery destination | Read |
| GetDeliveryDestinationPolicy | Retrieve a delivery destination policy attached to a delivery destination | Read |
| GetDeliverySource | Retrieve a single delivery source | Read |
| GetIntegration | Retrieve a single integration | Read |
| GetLogAnomalyDetector | Get a log anomaly detector | Read |
| GetLogDelivery | Get the log delivery information for specified log delivery | Read |
| GetLogEvents | Retrieve log events from the specified log stream | Read |
| GetLogFields | Retrieve a list of log fields for a data source | Read |
| GetLogGroupFields | Return 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 | Read |
| GetLogRecord | Retrieve all the fields and values of a single log event | Read |
| GetLookupTable | Retrieve a lookup table | Read |
| GetQueryResults | Return the results from the specified query | Read |
| GetScheduledQuery | Retrieve information about a specified scheduled query | Read |
| GetScheduledQueryHistory | Return the execution history for a specified scheduled query | Read |
| GetTransformer | Return transformer associated with the specified log group | Read |
| ListAggregateLogGroupSummaries | Return an aggregate summary of all log groups in the region grouped by specified data-source characteristics | List |
| ListAnomalies | List all anomalies detected in the AWS account making the request | List |
| ListEntitiesForLogGroup | Retrieve all the entities that are associated with log group | List |
| ListIntegrations | List all integrations associated with the AWS account making the request | List |
| ListLogAnomalyDetectors | Return all the anomaly detectors that are associated with the AWS account making the request | List |
| ListLogDeliveries | List all the log deliveries for specified account and/or log source | List |
| ListLogGroups | Return all the log groups that are associated with the AWS account making the request | List |
| ListLogGroupsForEntity | Retrieve all the log groups that are associated with entity | List |
| ListLogGroupsForQuery | Return all the log groups that are associated with the specified query | List |
| ListScheduledQueries | Return all scheduled queries that are associated with the AWS account making the request | List |
| ListSourcesForS3TableIntegration | Return all log sources associated with an S3 Tables integration | List |
| ListTagsForResource | List the tags for the specified resource | List |
| ListTagsLogGroup | List the tags for the specified log group | List |
| StartLiveTail | Start a Live Tail session in CloudWatch Logs | Read |
| StartQuery | Schedule a query of a log group using CloudWatch Logs Insights | Read |
| StopLiveTail | Stop a Live Tail session that is in progress | Read |
| StopQuery | Stop a CloudWatch Logs Insights query that is in progress | Read |
| TestMetricFilter | Test the filter pattern of a metric filter against a sample of log event messages | Read |
| TestTransformer | Test the transformer against a sample of log event messages | Read |
| Unmask | Fetch unmasked log events that have been redacted with a data protection policy | Read |
