View a markdown version of this page

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

Data retrieval APIs for Amazon CloudWatch

Amazon CloudWatch provides the following APIs for data retrieval.

Actions Description Access level
BatchGetServiceLevelIndicatorReportBatch get service level indicator reportRead
BatchGetServiceLevelObjectiveBudgetReportBatch retrieve a service level objective budget reportRead
DescribeAlarmHistoryRetrieve the history for the specified alarmRead
DescribeAlarmsDescribe all alarms, currently owned by the user's accountRead
DescribeAlarmsForMetricDescribe all alarms configured on the specified metric, currently owned by the user's accountRead
DescribeAnomalyDetectorsList the anomaly detection models that you have created in your accountRead
DescribeInsightRulesDescribe all insight rules, currently owned by the user's accountRead
GenerateQueryGenerate a Metrics Insights or Logs Insights query string from a natural language promptRead
GenerateQueryResultsSummaryGenerate a summary of CloudWatch LogInsights query results in natural language using generative AIRead
GetAccessGrantGet an access grantRead
GetAccessProfileGet an access profileRead
GetAgentGraphGet an agent graphRead
GetAlarmMuteRuleGet an alarm mute ruleRead
GetAlertGet an alertRead
GetContextGraphGet a context graphRead
GetDashboardDisplay the details of the CloudWatch dashboard you specifyRead
GetDatasetGet a datasetRead
GetDomainGet a domainRead
GetDomainAccessGrantForOrganizationGet a domain access grant for an organizationRead
GetDomainForOrganizationGet a domain for an organizationRead
GetIngestionEndpointGet an ingestion endpointRead
GetInsightRuleReportReturn the top-N report of unique contributors over a time range for a given insight ruleRead
GetIntegrationGet an integrationRead
GetIntelligenceConfigurationGet an intelligence configurationRead
GetMetricDataRetrieve batch amounts of CloudWatch classic metric data and perform metric math on retrieved data; and grants permission to retrieve OTLP metric data using PromQLRead
GetMetricStatisticsRetrieve statistics for the specified metricRead
GetMetricStreamReturn the details of a CloudWatch metric streamRead
GetMetricWidgetImageRetrieve snapshots of metric widgetsRead
GetOTelEnrichmentRetrieve the status of OTel Enrichment of vended metrics for PromQL queryingRead
GetOmniDashboardGet an omni dashboardRead
GetOmniThreadGet an omni threadRead
GetPreferencesGet preferencesRead
GetRecordsFetch logs and tracesRead
GetResourceMetricsConfigurationRetrieve the resource metrics configuration and detailed monitoring status for a resourceRead
GetServiceRetrieve information about a serviceRead
GetServiceDataRetrieve service dataRead
GetServiceLevelObjectiveRetrieve information about service level objectiveRead
GetSpaceGet a spaceRead
GetSpaceCredentialsGet space credentialsRead
GetSpaceCredentialsForOrganizationGet space credentials for an organizationRead
GetTelemetryQueryResultsGet telemetry query resultsRead
GetTopologyDiscoveryStatusRetrieve a CloudWatch topology discovery statusRead
GetTopologyMapRetrieve a CloudWatch topology mapRead
GetViewGet a viewRead
ListAccessGrantsList access grantsList
ListAccessProfilesList access profilesList
ListAlarmMuteRulesRetrieve a list of alarm mute rules owned by the user's accountList
ListAlertContributorsList alert contributorsList
ListAlertsList alertsList
ListDashboardsReturn a list of all CloudWatch dashboards in your accountList
ListDomainAccessGrantsForOrganizationList domain access grants for an organizationList
ListDomainsList domainsList
ListEntitiesForMetricRetrieve all the entities that are emitting a given metricList
ListIngestionEndpointsList ingestion endpointsList
ListIntegrationsList integrationsList
ListManagedInsightRulesList available managed Insight Rules for a given Resource ARNRead
ListMetricStreamsReturn a list of all CloudWatch metric streams in your accountList
ListMetricsRetrieve a list of valid metrics stored for the AWS account ownerList
ListOmniDashboardsList omni dashboardsList
ListOmniThreadsList omni threadsList
ListServiceLevelObjectivesList service level objectivesList
ListServicesList servicesList
ListSpaceAccessList access to a spaceList
ListSpacesList spacesList
ListSpacesForOrganizationList spaces for an organizationList
ListTagsForResourceList tags for an Amazon CloudWatch resourceList
ListTelemetryFieldsList telemetry fieldsList
ListTelemetryQuerySessionsList telemetry query sessionsList
ListViewsList viewsList