View Source aws_amp (aws v1.0.4)
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: https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html 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: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis to work within your Prometheus workspace.
Summary
Functions
The CreateAlertManagerDefinition
operation creates the alert manager definition in a workspace.
The CreateLoggingConfiguration
operation creates a logging configuration for the workspace.
The CreateRuleGroupsNamespace
operation creates a rule groups namespace within a workspace.
The CreateScraper
operation creates a scraper to collect metrics.
Creates a Prometheus workspace.
DeleteScraper
operation deletes one scraper, and stops any metrics collection that the scraper performs.Deletes an existing workspace.
Returns complete information about one rule groups namespace.
DescribeScraper
operation displays information about an existing scraper.GetDefaultScraperConfiguration
operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.The ListScrapers
operation lists all of the scrapers in your account.
The ListTagsForResource
operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.
Lists all of the Amazon Managed Service for Prometheus workspaces in your account.
Updates an existing alert manager definition in a workspace.
Updates an existing rule groups namespace within a workspace.
The TagResource
operation associates tags with an Amazon Managed Service for Prometheus resource.
Removes the specified tags from an Amazon Managed Service for Prometheus resource.
Functions
The CreateAlertManagerDefinition
operation creates the alert manager definition in a workspace.
PutAlertManagerDefinition
.
create_alert_manager_definition(Client, WorkspaceId, Input0, Options0)
View SourceThe CreateLoggingConfiguration
operation creates a logging configuration for the workspace.
create_logging_configuration(Client, WorkspaceId, Input0, Options0)
View SourceThe CreateRuleGroupsNamespace
operation creates a rule groups namespace within a workspace.
A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.
Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, usePutRuleGroupsNamespace
.
create_rule_groups_namespace(Client, WorkspaceId, Input0, Options0)
View SourceThe CreateScraper
operation creates a scraper to collect metrics.
A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace.
If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see Using roles for scraping metrics from EKS: https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper in the Amazon Managed Service for Prometheus User Guide.
You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one.
The scrapeConfiguration
parameter contains the base64-encoded version of the YAML configuration file.
Creates a Prometheus workspace.
A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.delete_alert_manager_definition(Client, WorkspaceId, Input0, Options0)
View Sourcedelete_logging_configuration(Client, WorkspaceId, Input0, Options0)
View Sourcedelete_rule_groups_namespace(Client, Name, WorkspaceId, Input0, Options0)
View SourceDeleteScraper
operation deletes one scraper, and stops any metrics collection that the scraper performs.
Deletes 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 within one month.describe_alert_manager_definition(Client, WorkspaceId, QueryMap, HeadersMap)
View Sourcedescribe_alert_manager_definition(Client, WorkspaceId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_logging_configuration(Client, WorkspaceId, QueryMap, HeadersMap)
View Sourcedescribe_logging_configuration(Client, WorkspaceId, QueryMap, HeadersMap, Options0)
View SourceReturns complete information about one rule groups namespace.
To retrieve a list of rule groups namespaces, useListRuleGroupsNamespaces
.
describe_rule_groups_namespace(Client, Name, WorkspaceId, QueryMap, HeadersMap)
View Sourcedescribe_rule_groups_namespace(Client, Name, WorkspaceId, QueryMap, HeadersMap, Options0)
View SourceDescribeScraper
operation displays information about an existing scraper.
describe_scraper(Client, ScraperId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_workspace(Client, WorkspaceId, QueryMap, HeadersMap, Options0)
View SourceGetDefaultScraperConfiguration
operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
get_default_scraper_configuration(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_rule_groups_namespaces(Client, WorkspaceId, QueryMap, HeadersMap)
View Sourcelist_rule_groups_namespaces(Client, WorkspaceId, QueryMap, HeadersMap, Options0)
View SourceThe ListScrapers
operation lists all of the scrapers in your account.
The ListTagsForResource
operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceLists all of the Amazon Managed Service for Prometheus workspaces in your account.
This includes workspaces being created or deleted.Updates 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 create it. Instead, useCreateAlertManagerDefinition
.
put_alert_manager_definition(Client, WorkspaceId, Input0, Options0)
View SourceUpdates an existing rule groups namespace within a workspace.
A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.
Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace
.
TagResource
.
put_rule_groups_namespace(Client, Name, WorkspaceId, Input0, Options0)
View SourceThe TagResource
operation associates tags with an Amazon Managed Service for Prometheus resource.
The only resources that can be tagged are workspaces and rule groups namespaces.
If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.Removes the specified tags from an Amazon Managed Service for Prometheus resource.
The only resources that can be tagged are workspaces and rule groups namespaces.