View Source AWS.Amp (aws-elixir v1.0.10)
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.
Creates an anomaly detector within a workspace using the Random Cut Forest algorithm for time-series analysis.
The CreateLoggingConfiguration operation creates rules and alerting logging
configuration for the workspace.
Creates a query logging configuration for the specified 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.
Removes an anomaly detector from a workspace.
Deletes the rules and alerting logging configuration for a workspace.
Deletes the query logging configuration for the specified workspace.
Deletes the resource-based policy attached to an Amazon Managed Service for Prometheus 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 the logging configuration for a Amazon Managed Service for Prometheus scraper.
Deletes an existing workspace.
Retrieves the full information about the alert manager definition for a workspace.
Retrieves detailed information about a specific anomaly detector, including its status and configuration.
Returns complete information about the current rules and alerting logging configuration of the workspace.
Retrieves the details of the query logging configuration for the specified workspace.
Returns information about the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.
Returns complete information about one rule groups namespace.
The DescribeScraper operation displays information about an existing scraper.
Describes the logging configuration for a Amazon Managed Service for Prometheus scraper.
Returns information about an existing workspace.
Use this operation to return information about the configuration of a workspace.
The GetDefaultScraperConfiguration operation returns the default scraper
configuration used when Amazon EKS creates a scraper for you.
Returns a paginated list of anomaly detectors for a workspace with optional filtering by alias.
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.
When you call PutAnomalyDetector, the operation creates a new anomaly detector
if one doesn't exist, or updates an existing one.
Creates or updates a resource-based policy for an Amazon Managed Service for Prometheus 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 rules and alerting logging configuration.
Updates the query logging configuration for the specified workspace.
Updates an existing scraper.
Updates the logging configuration for a Amazon Managed Service for Prometheus scraper.
Updates the alias of an existing workspace.
Use this operation to create or update the label sets, label set limits, and retention period of a 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_anomaly_detector(client, workspace_id, input, options \\ [])
View SourceCreates an anomaly detector within a workspace using the Random Cut Forest algorithm for time-series analysis.
The anomaly detector analyzes Amazon Managed Service for Prometheus metrics to identify unusual patterns and behaviors.
create_logging_configuration(client, workspace_id, input, options \\ [])
View SourceThe CreateLoggingConfiguration operation creates rules and alerting logging
configuration for the workspace.
Use this operation to set the CloudWatch log group to which the logs will be published to.
These logging configurations are only for rules and alerting logs.
create_query_logging_configuration(client, workspace_id, input, options \\ [])
View SourceCreates a query logging configuration for the specified workspace.
This operation enables logging of queries that exceed the specified QSP threshold.
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.
The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.
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 and sends them to your Amazon Managed Service for Prometheus workspace. You can configure scrapers to collect metrics from Amazon EKS clusters, Amazon MSK clusters, or from VPC-based sources that support DNS-based service discovery. 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 source. You must configure this role with a policy that allows it to scrape metrics from your source. For Amazon EKS sources, 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.
When creating a scraper, the service creates a Network Interface in each
Availability Zone that are passed into CreateScraper through subnets.
These network interfaces are used to connect to your source within the VPC for
scraping metrics.
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_anomaly_detector(client, anomaly_detector_id, workspace_id, input, options \\ [])
View SourceRemoves an anomaly detector from a workspace.
This operation is idempotent.
delete_logging_configuration(client, workspace_id, input, options \\ [])
View SourceDeletes the rules and alerting logging configuration for a workspace.
These logging configurations are only for rules and alerting logs.
delete_query_logging_configuration(client, workspace_id, input, options \\ [])
View SourceDeletes the query logging configuration for the specified workspace.
delete_resource_policy(client, workspace_id, input, options \\ [])
View SourceDeletes the resource-based policy attached to an Amazon Managed Service for Prometheus 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.
delete_scraper_logging_configuration(client, scraper_id, input, options \\ [])
View SourceDeletes the logging configuration for a Amazon Managed Service for Prometheus scraper.
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_anomaly_detector(client, anomaly_detector_id, workspace_id, options \\ [])
View SourceRetrieves detailed information about a specific anomaly detector, including its status and configuration.
describe_logging_configuration(client, workspace_id, options \\ [])
View SourceReturns complete information about the current rules and alerting logging configuration of the workspace.
These logging configurations are only for rules and alerting logs.
describe_query_logging_configuration(client, workspace_id, options \\ [])
View SourceRetrieves the details of the query logging configuration for the specified workspace.
Returns information about the resource-based policy attached to an Amazon Managed Service for Prometheus 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.
describe_scraper_logging_configuration(client, scraper_id, options \\ [])
View SourceDescribes the logging configuration for a Amazon Managed Service for Prometheus scraper.
Returns information about an existing workspace.
describe_workspace_configuration(client, workspace_id, options \\ [])
View SourceUse this operation to return information about the configuration of a workspace.
The configuration details returned include workspace configuration status, label set limits, and retention period.
The GetDefaultScraperConfiguration operation returns the default scraper
configuration used when Amazon EKS creates a scraper for you.
list_anomaly_detectors(client, workspace_id, alias \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a paginated list of anomaly detectors for a workspace with optional filtering by alias.
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_anomaly_detector(client, anomaly_detector_id, workspace_id, input, options \\ [])
View SourceWhen 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 triggers a complete retraining of the detector, which includes querying the minimum required samples and backfilling the detector with historical data. This process occurs regardless of whether you're making a minor change like updating the evaluation interval or making more substantial modifications. The operation serves as the single method for creating, updating, and retraining anomaly detectors.
Creates or updates a resource-based policy for an Amazon Managed Service for Prometheus workspace.
Use resource-based policies to grant permissions to other AWS accounts or services to access your workspace.
Only Prometheus-compatible APIs can be used for workspace sharing. You can add non-Prometheus-compatible APIs to the policy, but they will be ignored. For more information, see Prometheus-compatible APIs in the Amazon Managed Service for Prometheus User Guide.
If your workspace uses customer-managed KMS keys for encryption, you must grant the principals in your resource-based policy access to those KMS keys. You can do this by creating KMS grants. For more information, see CreateGrant in the AWS Key Management Service API Reference and Encryption at rest in the Amazon Managed Service for Prometheus User Guide.
For more information about working with IAM, see Using Amazon Managed Service for Prometheus with IAM in the Amazon Managed Service for Prometheus User Guide.
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.
The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.
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 rules and alerting logging configuration.
These logging configurations are only for rules and alerting logs.
update_query_logging_configuration(client, workspace_id, input, options \\ [])
View SourceUpdates the query logging configuration for the specified workspace.
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_scraper_logging_configuration(client, scraper_id, input, options \\ [])
View SourceUpdates the logging configuration for a Amazon Managed Service for Prometheus scraper.
update_workspace_alias(client, workspace_id, input, options \\ [])
View SourceUpdates the alias of an existing workspace.
update_workspace_configuration(client, workspace_id, input, options \\ [])
View SourceUse 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 limitsPerLabelSet or retentionPeriodInDays
for the request to be valid.