Data retrieval APIs for Amazon CloudWatch Logs - AWS Online Register of Data Formats

Data retrieval APIs for Amazon CloudWatch Logs

Amazon CloudWatch Logs provides the following APIs for data retrieval.

Actions Description Access level
DescribeAccountPoliciesRetrieve account policiesList
DescribeConfigurationTemplatesRetrieve a list of configuration templates of available log typesList
DescribeDeliveriesRetrieve a list of deliveries an accountList
DescribeDeliveryDestinationsRetrieve a list of delivery destinations an accountList
DescribeDeliverySourcesRetrieve a list of delivery sources in an accountList
DescribeDestinationsReturn all the destinations that are associated with the AWS account making the requestList
DescribeExportTasksReturn all the export tasks that are associated with the AWS account making the requestList
DescribeFieldIndexesReturn all the indexing attributes that are attached with the log groupsList
DescribeIndexPoliciesReturn all the index policies that are attached with the log groupsList
DescribeLogGroupsReturn all the log groups that are associated with the AWS account making the requestList
DescribeLogStreamsReturn all the log streams that are associated with the specified log groupList
DescribeMetricFiltersReturn all the metrics filters associated with the specified log groupList
DescribeQueriesReturn a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this accountList
DescribeQueryDefinitionsReturn a paginated list of your saved CloudWatch Logs Insights query definitionsList
DescribeResourcePoliciesReturn all the resource policies in this accountList
DescribeSubscriptionFiltersReturn all the subscription filters associated with the specified log groupList
FilterLogEventsRetrieve log events, optionally filtered by a filter pattern from the specified log groupRead
GetDataProtectionPolicyRetrieve a data protection policy attached to a log groupRead
GetDeliveryRetrieve a single deliveryRead
GetDeliveryDestinationRetrieve a single delivery destinationRead
GetDeliveryDestinationPolicyRetrieve a delivery destination policy attached to a delivery destinationRead
GetDeliverySourceRetrieve a single delivery sourceRead
GetIntegrationRetrieve a single integrationRead
GetLogAnomalyDetectorGet a log anomaly detectorRead
GetLogDeliveryGet the log delivery information for specified log deliveryRead
GetLogEventsRetrieve log events from the specified log streamRead
GetLogGroupFieldsReturn 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 fieldRead
GetLogRecordRetrieve all the fields and values of a single log eventRead
GetQueryResultsReturn the results from the specified queryRead
GetTransformerReturn transformer associated with the specified log groupRead
ListAnomaliesList all anomalies detected in the AWS account making the requestList
ListEntitiesForLogGroupRetrieve all the entities that are associated with log groupList
ListIntegrationsList all integrations associated with the AWS account making the requestList
ListLogAnomalyDetectorsReturn all the anomaly detectors that are associated with the AWS account making the requestList
ListLogDeliveriesList all the log deliveries for specified account and/or log sourceList
ListLogGroupsReturn all the log groups that are associated with the AWS account making the requestList
ListLogGroupsForEntityRetrieve all the log groups that are associated with entityList
ListLogGroupsForQueryReturn all the log groups that are associated with the specified queryList
ListTagsForResourceList the tags for the specified resourceList
ListTagsLogGroupList the tags for the specified log groupList
StartLiveTailStart a Live Tail session in CloudWatch LogsRead
StartQuerySchedule a query of a log group using CloudWatch Logs InsightsRead
StopLiveTailStop a Live Tail session that is in progressRead
StopQueryStop a CloudWatch Logs Insights query that is in progressRead
TestMetricFilterTest the filter pattern of a metric filter against a sample of log event messagesRead
TestTransformerTest the transformer against a sample of log event messagesRead
UnmaskFetch unmasked log events that have been redacted with a data protection policyRead