Amazon Prometheus Service
Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure. For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide. Amazon Managed Service for Prometheus includes two APIs. Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert managers. Use the Prometheus-compatible API to work within your Prometheus workspace.
Endpoints 44
Alert manager definition
- GETDescribe alert manager definition
/workspaces/:workspaceId/alertmanager/definitionRetrieves the full information about the alert manager definition for a workspace. - PUTPut alert manager definition
/workspaces/:workspaceId/alertmanager/definitionUpdates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to… - POSTCreate alert manager definition
/workspaces/:workspaceId/alertmanager/definitionThe CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't… - DELETEDelete alert manager definition
/workspaces/:workspaceId/alertmanager/definition?clientToken=stringDeletes the alert manager definition from a workspace.
Anomaly detector
- GETList anomaly detectors
/workspaces/:workspaceId/anomalydetectors?alias=string&maxResults=0&nextToken=stringReturns a paginated list of anomaly detectors for a workspace with optional filtering by alias. - POSTCreate anomaly detector
/workspaces/:workspaceId/anomalydetectorsCreates an anomaly detector within a workspace using the Random Cut Forest algorithm for time-series analysis. The anomaly detector analyzes Amazon Managed… - GETDescribe anomaly detector
/workspaces/:workspaceId/anomalydetectors/:anomalyDetectorIdRetrieves detailed information about a specific anomaly detector, including its status and configuration. - PUTPut anomaly detector
/workspaces/:workspaceId/anomalydetectors/:anomalyDetectorIdWhen you call PutAnomalyDetector , the operation creates a new anomaly detector if one doesn't exist, or updates an existing one. Each call to this operation… - DELETEDelete anomaly detector
/workspaces/:workspaceId/anomalydetectors/:anomalyDetectorId?clientToken=stringRemoves an anomaly detector from a workspace. This operation is idempotent.
Logging configuration
- GETDescribe logging configuration
/workspaces/:workspaceId/loggingReturns complete information about the current rules and alerting logging configuration of the workspace. These logging configurations are only for rules and… - PUTUpdate logging configuration
/workspaces/:workspaceId/loggingUpdates the log group ARN or the workspace ID of the current rules and alerting logging configuration. These logging configurations are only for rules and… - POSTCreate logging configuration
/workspaces/:workspaceId/loggingThe CreateLoggingConfiguration operation creates rules and alerting logging configuration for the workspace. Use this operation to set the CloudWatch log… - DELETEDelete logging configuration
/workspaces/:workspaceId/logging?clientToken=stringDeletes the rules and alerting logging configuration for a workspace. These logging configurations are only for rules and alerting logs.
Query logging configuration
- GETDescribe query logging configuration
/workspaces/:workspaceId/logging/queryRetrieves the details of the query logging configuration for the specified workspace. - PUTUpdate query logging configuration
/workspaces/:workspaceId/logging/queryUpdates the query logging configuration for the specified workspace. - POSTCreate query logging configuration
/workspaces/:workspaceId/logging/queryCreates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold. - DELETEDelete query logging configuration
/workspaces/:workspaceId/logging/query?clientToken=stringDeletes the query logging configuration for the specified workspace.
Rule groups namespace
- GETList rule groups namespaces
/workspaces/:workspaceId/rulegroupsnamespaces?name=string&nextToken=string&maxResults=0Returns a list of rule groups namespaces in a workspace. - POSTCreate rule groups namespace
/workspaces/:workspaceId/rulegroupsnamespacesThe CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file.… - GETDescribe rule groups namespace
/workspaces/:workspaceId/rulegroupsnamespaces/:nameReturns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces . - PUTPut rule groups namespace
/workspaces/:workspaceId/rulegroupsnamespaces/:nameUpdates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple… - DELETEDelete rule groups namespace
/workspaces/:workspaceId/rulegroupsnamespaces/:name?clientToken=stringDeletes one rule groups namespace and its associated rule groups definition.
Scraper
- GETList scrapers
/scrapers?nextToken=string&maxResults=0The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned… - POSTCreate scraper
/scrapersCreates a scraper to collect metrics from Prometheus-compatible sources. The scraper sends the collected metrics to Amazon Managed Service for Prometheus… - GETDescribe scraper
/scrapers/:scraperIdThe DescribeScraper operation displays information about an existing scraper. - PUTUpdate scraper
/scrapers/:scraperIdUpdates an existing scraper. You can't use this function to update the source from which the scraper is collecting metrics. To change the source, delete the… - DELETEDelete scraper
/scrapers/:scraperId?clientToken=stringThe DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
Workspace
- GETList workspaces
/workspaces?nextToken=string&alias=string&maxResults=0Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted. - POSTCreate workspace
/workspacesCreates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more… - GETDescribe workspace
/workspaces/:workspaceIdReturns information about an existing workspace. - DELETEDelete workspace
/workspaces/:workspaceId?clientToken=stringDeletes an existing workspace. When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted… - POSTUpdate workspace alias
/workspaces/:workspaceId/aliasUpdates the alias of an existing workspace.
Workspace resource policy
- GETDescribe resource policy
/workspaces/:workspaceId/policyReturns information about the resource-based policy attached to an Amazon Managed Service for Prometheus workspace. - PUTPut resource policy
/workspaces/:workspaceId/policyCreates or updates a resource-based policy for an Amazon Managed Service for Prometheus workspace. Use resource-based policies to grant permissions to other… - DELETEDelete resource policy
/workspaces/:workspaceId/policy?clientToken=string&revisionId=stringDeletes the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.
Scraper logging configuration
- GETDescribe scraper logging configuration
/scrapers/:scraperId/logging-configurationDescribes the logging configuration for a Amazon Managed Service for Prometheus scraper. - PUTUpdate scraper logging configuration
/scrapers/:scraperId/logging-configurationUpdates the logging configuration for a Amazon Managed Service for Prometheus scraper. - DELETEDelete scraper logging configuration
/scrapers/:scraperId/logging-configuration?clientToken=stringDeletes the logging configuration for a Amazon Managed Service for Prometheus scraper.
Workspace configuration
- GETDescribe workspace configuration
/workspaces/:workspaceId/configurationUse this operation to return information about the configuration of a workspace. The configuration details returned include workspace configuration status,… - PATCHUpdate workspace configuration
/workspaces/:workspaceId/configurationUse this operation to create or update the label sets, label set limits, and retention period of a workspace. You must specify at least one of…
- GETGet default scraper configuration
/scraperconfigurationThe GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you. - GETList tags for resource
/tags/:resourceArnThe ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources… - POSTTag resource
/tags/:resourceArnThe TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups… - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers,…
API details
- Base URL
https://aps.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 44 operations on 17 pathsGET 16DELETE 10POST 9PUT 8PATCH 1
- Main resources
- Anomaly detector 5Rule groups namespace 5Scraper 5Workspace 5Alert manager definition 4Logging configuration 4Query logging configuration 4Scraper logging configuration 3Workspace resource policy 3Workspace configuration 2
- Description format
- AWS Smithy model, API version
2020-08-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Prometheus Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Prometheus Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Describe alert manager definition” (GET /workspaces/:workspaceId/alertmanager/definition), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Prometheus Service?
Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor… It is listed under Developer tools and has 44 endpoints.
Who publishes the Amazon Prometheus Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Prometheus Service?
Requests go to https://aps.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Prometheus Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Prometheus Service have?
44 operations on 17 paths (16 GET, 10 DELETE, 9 POST, 8 PUT, 1 PATCH). The largest groups are Anomaly detector, Rule groups namespace, Scraper, Workspace.
Is forking the Amazon Prometheus Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.