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.

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 the alias of an existing workspace.

Functions

Link to this function

create_alert_manager_definition(Client, WorkspaceId, Input)

View Source

The 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.
Link to this function

create_alert_manager_definition(Client, WorkspaceId, Input0, Options0)

View Source
Link to this function

create_logging_configuration(Client, WorkspaceId, Input)

View Source

The 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.
Link to this function

create_logging_configuration(Client, WorkspaceId, Input0, Options0)

View Source
Link to this function

create_rule_groups_namespace(Client, WorkspaceId, Input)

View Source

The 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.
Link to this function

create_rule_groups_namespace(Client, WorkspaceId, Input0, Options0)

View Source
Link to this function

create_scraper(Client, Input)

View Source

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. 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.

For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html in the Amazon Managed Service for Prometheus User Guide.
Link to this function

create_scraper(Client, Input0, Options0)

View Source
Link to this function

create_workspace(Client, Input)

View Source

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.
Link to this function

create_workspace(Client, Input0, Options0)

View Source
Link to this function

delete_alert_manager_definition(Client, WorkspaceId, Input)

View Source
Deletes the alert manager definition from a workspace.
Link to this function

delete_alert_manager_definition(Client, WorkspaceId, Input0, Options0)

View Source
Link to this function

delete_logging_configuration(Client, WorkspaceId, Input)

View Source
Deletes the logging configuration for a workspace.
Link to this function

delete_logging_configuration(Client, WorkspaceId, Input0, Options0)

View Source
Link to this function

delete_rule_groups_namespace(Client, Name, WorkspaceId, Input)

View Source
Deletes one rule groups namespace and its associated rule groups definition.
Link to this function

delete_rule_groups_namespace(Client, Name, WorkspaceId, Input0, Options0)

View Source
Link to this function

delete_scraper(Client, ScraperId, Input)

View Source
The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
Link to this function

delete_scraper(Client, ScraperId, Input0, Options0)

View Source
Link to this function

delete_workspace(Client, WorkspaceId, Input)

View Source

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.
Link to this function

delete_workspace(Client, WorkspaceId, Input0, Options0)

View Source
Link to this function

describe_alert_manager_definition(Client, WorkspaceId)

View Source
Retrieves the full information about the alert manager definition for a workspace.
Link to this function

describe_alert_manager_definition(Client, WorkspaceId, QueryMap, HeadersMap)

View Source
Link to this function

describe_alert_manager_definition(Client, WorkspaceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_logging_configuration(Client, WorkspaceId)

View Source
Returns complete information about the current logging configuration of the workspace.
Link to this function

describe_logging_configuration(Client, WorkspaceId, QueryMap, HeadersMap)

View Source
Link to this function

describe_logging_configuration(Client, WorkspaceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_rule_groups_namespace(Client, Name, WorkspaceId)

View Source

Returns complete information about one rule groups namespace.

To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.
Link to this function

describe_rule_groups_namespace(Client, Name, WorkspaceId, QueryMap, HeadersMap)

View Source
Link to this function

describe_rule_groups_namespace(Client, Name, WorkspaceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_scraper(Client, ScraperId)

View Source
The DescribeScraper operation displays information about an existing scraper.
Link to this function

describe_scraper(Client, ScraperId, QueryMap, HeadersMap)

View Source
Link to this function

describe_scraper(Client, ScraperId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_workspace(Client, WorkspaceId)

View Source
Returns information about an existing workspace.
Link to this function

describe_workspace(Client, WorkspaceId, QueryMap, HeadersMap)

View Source
Link to this function

describe_workspace(Client, WorkspaceId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_default_scraper_configuration(Client)

View Source
The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
Link to this function

get_default_scraper_configuration(Client, QueryMap, HeadersMap)

View Source
Link to this function

get_default_scraper_configuration(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_rule_groups_namespaces(Client, WorkspaceId)

View Source
Returns a list of rule groups namespaces in a workspace.
Link to this function

list_rule_groups_namespaces(Client, WorkspaceId, QueryMap, HeadersMap)

View Source
Link to this function

list_rule_groups_namespaces(Client, WorkspaceId, QueryMap, HeadersMap, Options0)

View Source

The ListScrapers operation lists all of the scrapers in your account.

This includes scrapers being created or deleted. You can optionally filter the returned list.
Link to this function

list_scrapers(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_scrapers(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn)

View Source

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 workspaces and rule groups namespaces.
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)

View Source

Lists all of the Amazon Managed Service for Prometheus workspaces in your account.

This includes workspaces being created or deleted.
Link to this function

list_workspaces(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_workspaces(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

put_alert_manager_definition(Client, WorkspaceId, Input)

View Source

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, use CreateAlertManagerDefinition.
Link to this function

put_alert_manager_definition(Client, WorkspaceId, Input0, Options0)

View Source
Link to this function

put_rule_groups_namespace(Client, Name, WorkspaceId, Input)

View Source

Updates 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.
Link to this function

put_rule_groups_namespace(Client, Name, WorkspaceId, Input0, Options0)

View Source
Link to this function

tag_resource(Client, ResourceArn, Input)

View Source

The 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.
Link to this function

tag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceArn, Input)

View Source

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.
Link to this function

untag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

update_logging_configuration(Client, WorkspaceId, Input)

View Source
Updates the log group ARN or the workspace ID of the current logging configuration.
Link to this function

update_logging_configuration(Client, WorkspaceId, Input0, Options0)

View Source
Link to this function

update_workspace_alias(Client, WorkspaceId, Input)

View Source
Updates the alias of an existing workspace.
Link to this function

update_workspace_alias(Client, WorkspaceId, Input0, Options0)

View Source