AmpClient

interface AmpClient : SdkClient

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.

Properties

Link copied to clipboard
abstract override val config: AmpClient.Config

AmpClient's configuration

Functions

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

Creates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun createWorkspace(input: CreateWorkspaceRequest = CreateWorkspaceRequest { }): CreateWorkspaceResponse

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 copied to clipboard

Deletes the alert manager definition from a workspace.

Link copied to clipboard

Deletes the rules and alerting logging configuration for a workspace.

Link copied to clipboard

Deletes the query logging configuration for the specified workspace.

Link copied to clipboard

Deletes one rule groups namespace and its associated rule groups definition.

Link copied to clipboard

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

Link copied to clipboard

Deletes an existing workspace.

Link copied to clipboard

Retrieves the full information about the alert manager definition for a workspace.

Link copied to clipboard

Returns complete information about the current rules and alerting logging configuration of the workspace.

Link copied to clipboard

Retrieves the details of the query logging configuration for the specified workspace.

Link copied to clipboard

Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.

Link copied to clipboard

The DescribeScraper operation displays information about an existing scraper.

Link copied to clipboard

Returns information about an existing workspace.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun getDefaultScraperConfiguration(input: GetDefaultScraperConfigurationRequest = GetDefaultScraperConfigurationRequest { }): GetDefaultScraperConfigurationResponse

The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

Link copied to clipboard

Returns a list of rule groups namespaces in a workspace.

Link copied to clipboard
abstract suspend fun listScrapers(input: ListScrapersRequest = ListScrapersRequest { }): ListScrapersResponse

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 copied to clipboard

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.

Link copied to clipboard
abstract suspend fun listWorkspaces(input: ListWorkspacesRequest = ListWorkspacesRequest { }): ListWorkspacesResponse

Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.

Link copied to clipboard

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 copied to clipboard

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.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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.

Link copied to clipboard

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.

Link copied to clipboard

Updates the log group ARN or the workspace ID of the current rules and alerting logging configuration.

Link copied to clipboard

Updates the query logging configuration for the specified workspace.

Link copied to clipboard

Updates an existing scraper.

Link copied to clipboard

Updates the alias of an existing workspace.

Link copied to clipboard

Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

Creates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun AmpClient.createScraper(crossinline block: CreateScraperRequest.Builder.() -> Unit): CreateScraperResponse

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.

Link copied to clipboard

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 copied to clipboard

Deletes the alert manager definition from a workspace.

Link copied to clipboard

Deletes the rules and alerting logging configuration for a workspace.

Link copied to clipboard

Deletes the query logging configuration for the specified workspace.

Link copied to clipboard

Deletes one rule groups namespace and its associated rule groups definition.

Link copied to clipboard
inline suspend fun AmpClient.deleteScraper(crossinline block: DeleteScraperRequest.Builder.() -> Unit): DeleteScraperResponse

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

Link copied to clipboard

Deletes an existing workspace.

Link copied to clipboard

Retrieves the full information about the alert manager definition for a workspace.

Link copied to clipboard

Returns complete information about the current rules and alerting logging configuration of the workspace.

Link copied to clipboard

Retrieves the details of the query logging configuration for the specified workspace.

Link copied to clipboard

Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.

Link copied to clipboard

The DescribeScraper operation displays information about an existing scraper.

Link copied to clipboard

Returns information about an existing workspace.

Link copied to clipboard

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

Link copied to clipboard

The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

Link copied to clipboard

Returns a list of rule groups namespaces in a workspace.

Link copied to clipboard
inline suspend fun AmpClient.listScrapers(crossinline block: ListScrapersRequest.Builder.() -> Unit): ListScrapersResponse

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 copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.

Link copied to clipboard
Link copied to clipboard

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 copied to clipboard

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.

Link copied to clipboard
inline suspend fun AmpClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

Link copied to clipboard
inline suspend fun AmpClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

Link copied to clipboard

Updates the log group ARN or the workspace ID of the current rules and alerting logging configuration.

Link copied to clipboard

Updates the query logging configuration for the specified workspace.

Link copied to clipboard
inline suspend fun AmpClient.updateScraper(crossinline block: UpdateScraperRequest.Builder.() -> Unit): UpdateScraperResponse

Updates an existing scraper.

Link copied to clipboard

Updates the alias of an existing workspace.

Link copied to clipboard

Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

Link copied to clipboard

Wait until a scraper reaches ACTIVE status

Link copied to clipboard

Wait until a scraper reaches DELETED status

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.