Module types

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that Amazon Prometheus Service can respond with.

Structs§

AlertManagerDefinitionDescription

The details of an alert manager definition. It is the configuration for the alert manager, including information about receivers for routing alerts.

AlertManagerDefinitionStatus

The status of the alert manager.

AmpConfiguration

The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.

CloudWatchLogDestination

Configuration details for logging to CloudWatch Logs.

EksConfiguration

The EksConfiguration structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.

LimitsPerLabelSet

This structure defines one label set used to enforce active time series limits for the workspace, and defines the limit for that label set.

A label set is a unique combination of label-value pairs. Use them to control time series limits and to monitor usage by specific label groups. Example label sets might be team:finance or env:prod

LimitsPerLabelSetEntry

This structure contains the information about the limits that apply to time series that match one label set.

LoggingConfigurationMetadata

Contains information about the current rules and alerting logging configuration for the workspace.

These logging configurations are only for rules and alerting logs.

LoggingConfigurationStatus

The status of the logging configuration.

LoggingDestination

Defines a destination and its associated filtering criteria for query logging.

LoggingFilter

Filtering criteria that determine which queries are logged.

QueryLoggingConfigurationMetadata

The metadata for a query logging configuration.

QueryLoggingConfigurationStatus

The status information for a query logging configuration.

RoleConfiguration

Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

RuleGroupsNamespaceDescription

The details about one rule groups namespace.

RuleGroupsNamespaceStatus

The status information about a rule groups namespace.

RuleGroupsNamespaceSummary

The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace.

ScraperDescription

The ScraperDescription structure contains the full details about one scraper in your account.

ScraperStatus

The ScraperStatus structure contains status information about the scraper.

ScraperSummary

The ScraperSummary structure contains a summary of the details about one scraper in your account.

ValidationExceptionField

Information about a field passed into a request that resulted in an exception.

WorkspaceConfigurationDescription

This structure contains the description of the workspace configuration.

WorkspaceConfigurationStatus

This structure displays the current status of the workspace configuration, and might also contain a reason for that status.

WorkspaceDescription

The full details about one Amazon Managed Service for Prometheus workspace in your account.

WorkspaceStatus

The status of the workspace.

WorkspaceSummary

The information about one Amazon Managed Service for Prometheus workspace in your account.

Enums§

AlertManagerDefinitionStatusCode
When writing a match expression against AlertManagerDefinitionStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Destination

Where to send the metrics from a scraper.

LoggingConfigurationStatusCode
When writing a match expression against LoggingConfigurationStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
QueryLoggingConfigurationStatusCode
When writing a match expression against QueryLoggingConfigurationStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RuleGroupsNamespaceStatusCode
When writing a match expression against RuleGroupsNamespaceStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ScrapeConfiguration

A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

ScraperStatusCode
When writing a match expression against ScraperStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Source

The source of collected metrics for a scraper.

ValidationExceptionReason
When writing a match expression against ValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
WorkspaceConfigurationStatusCode
When writing a match expression against WorkspaceConfigurationStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
WorkspaceStatusCode
When writing a match expression against WorkspaceStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.