Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Alert
Manager Definition Description The details of an alert manager definition. It is the configuration for the alert manager, including information about receivers for routing alerts.
- Alert
Manager Definition Status The status of the alert manager.
- AmpConfiguration
The
AmpConfiguration
structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.- Cloud
Watch LogDestination 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.- Limits
PerLabel Set 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
orenv:prod
- Limits
PerLabel SetEntry This structure contains the information about the limits that apply to time series that match one label set.
- Logging
Configuration Metadata Contains information about the current rules and alerting logging configuration for the workspace.
These logging configurations are only for rules and alerting logs.
- Logging
Configuration Status The status of the logging configuration.
- Logging
Destination Defines a destination and its associated filtering criteria for query logging.
- Logging
Filter Filtering criteria that determine which queries are logged.
- Query
Logging Configuration Metadata The metadata for a query logging configuration.
- Query
Logging Configuration Status The status information for a query logging configuration.
- Role
Configuration Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.
- Rule
Groups Namespace Description The details about one rule groups namespace.
- Rule
Groups Namespace Status The status information about a rule groups namespace.
- Rule
Groups Namespace Summary The high-level information about a rule groups namespace. To retrieve more information, use
DescribeRuleGroupsNamespace
.- Scraper
Description The
ScraperDescription
structure contains the full details about one scraper in your account.- Scraper
Status The
ScraperStatus
structure contains status information about the scraper.- Scraper
Summary The
ScraperSummary
structure contains a summary of the details about one scraper in your account.- Validation
Exception Field Information about a field passed into a request that resulted in an exception.
- Workspace
Configuration Description This structure contains the description of the workspace configuration.
- Workspace
Configuration Status This structure displays the current status of the workspace configuration, and might also contain a reason for that status.
- Workspace
Description The full details about one Amazon Managed Service for Prometheus workspace in your account.
- Workspace
Status The status of the workspace.
- Workspace
Summary The information about one Amazon Managed Service for Prometheus workspace in your account.
Enums§
- Alert
Manager Definition Status Code - 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.
- Logging
Configuration Status Code - 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. - Query
Logging Configuration Status Code - 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. - Rule
Groups Namespace Status Code - 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. - Scrape
Configuration A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
- Scraper
Status Code - 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.
- Validation
Exception Reason - 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. - Workspace
Configuration Status Code - 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. - Workspace
Status Code - 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.