View Source AWS.Amp (aws-elixir 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 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.
Link to this section 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.
Deletes the alert manager definition from a workspace.
Deletes the logging configuration for a workspace.
Deletes one rule groups namespace and its associated rule groups definition.
The DeleteScraper operation deletes one scraper, and stops any metrics
collection that the scraper performs.
Deletes an existing workspace.
Retrieves the full information about the alert manager definition for a workspace.
Returns complete information about the current logging configuration of the workspace.
Returns complete information about one rule groups namespace.
The DescribeScraper operation displays information about an existing
scraper.
Returns information about an existing workspace.
The GetDefaultScraperConfiguration operation returns the default
scraper configuration used when Amazon EKS creates a scraper for you.
Returns a list of rule groups namespaces in a workspace.
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.
Updates the log group ARN or the workspace ID of the current logging configuration.
Updates an existing scraper.
Updates the alias of an existing workspace.
Link to this section Functions
create_alert_manager_definition(client, workspace_id, input, options \\ [])
View SourceThe CreateAlertManagerDefinition operation creates the alert manager
definition in a workspace.
If a workspace already has an alert manager definition, don't
use this operation to update it. Instead, use
PutAlertManagerDefinition.
create_logging_configuration(client, workspace_id, input, options \\ [])
View SourceThe CreateLoggingConfiguration operation creates a logging configuration
for the workspace.
Use this operation to set the CloudWatch log group to which the logs will be published to.
create_rule_groups_namespace(client, workspace_id, input, options \\ [])
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, use PutRuleGroupsNamespace.
The 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. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.
An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.
The scrapeConfiguration parameter contains the base-64 encoded YAML
configuration for the scraper.
For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.
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, workspace_id, input, options \\ [])
View SourceDeletes the alert manager definition from a workspace.
delete_logging_configuration(client, workspace_id, input, options \\ [])
View SourceDeletes the logging configuration for a workspace.
delete_rule_groups_namespace(client, name, workspace_id, input, options \\ [])
View SourceDeletes one rule groups namespace and its associated rule groups definition.
The DeleteScraper 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, workspace_id, options \\ [])
View SourceRetrieves the full information about the alert manager definition for a workspace.
describe_logging_configuration(client, workspace_id, options \\ [])
View SourceReturns complete information about the current logging configuration of the workspace.
describe_rule_groups_namespace(client, name, workspace_id, options \\ [])
View SourceReturns complete information about one rule groups namespace.
To retrieve a list of
rule groups namespaces, use ListRuleGroupsNamespaces.
The DescribeScraper operation displays information about an existing
scraper.
Returns information about an existing workspace.
The GetDefaultScraperConfiguration operation returns the default
scraper configuration used when Amazon EKS creates a scraper for you.
list_rule_groups_namespaces(client, workspace_id, max_results \\ nil, name \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of rule groups namespaces in a workspace.
list_scrapers(client, filters \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceThe ListScrapers operation lists all of the scrapers in
your account.
This includes scrapers being created or deleted. You can optionally filter the returned list.
The ListTagsForResource operation returns the tags that are associated
with an Amazon Managed Service for Prometheus resource.
Currently, the only resources that can be tagged are scrapers, workspaces, and rule groups namespaces.
list_workspaces(client, alias \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all of the Amazon Managed Service for Prometheus workspaces in your account.
This includes workspaces being created or deleted.
put_alert_manager_definition(client, workspace_id, input, options \\ [])
View SourceUpdates 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, use CreateAlertManagerDefinition.
put_rule_groups_namespace(client, name, workspace_id, input, options \\ [])
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.
You can't use this operation to add tags to an existing rule groups namespace.
Instead, use TagResource.
The TagResource operation associates tags with an Amazon Managed Service for
Prometheus
resource.
The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.
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. To remove a tag, use UntagResource.
Removes the specified tags from an Amazon Managed Service for Prometheus resource.
The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.
update_logging_configuration(client, workspace_id, input, options \\ [])
View SourceUpdates the log group ARN or the workspace ID of the current logging configuration.
Updates 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 scraper and create a new one.
update_workspace_alias(client, workspace_id, input, options \\ [])
View SourceUpdates the alias of an existing workspace.