Client
prometheusservice | R Documentation |
Amazon Prometheus Service¶
Description¶
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.
Usage¶
Arguments¶
config
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to
true
to force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY
.sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint
Optional shorthand for complete URL to use for the constructed client.
region
Optional shorthand for AWS Region used in instantiating the client.
Value¶
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've
assigned to the client. The available operations are listed in the
Operations section.
Service syntax¶
svc <- prometheusservice(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations¶
- create_alert_manager_definition
- The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace
- create_logging_configuration
- The CreateLoggingConfiguration operation creates a logging configuration for the workspace
- create_rule_groups_namespace
- The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace
- create_scraper
- The CreateScraper operation creates a scraper to collect metrics
- create_workspace
- Creates a Prometheus workspace
- delete_alert_manager_definition
- Deletes the alert manager definition from a workspace
- delete_logging_configuration
- Deletes the logging configuration for a workspace
- delete_rule_groups_namespace
- Deletes one rule groups namespace and its associated rule groups definition
- delete_scraper
- The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs
- delete_workspace
- Deletes an existing workspace
- describe_alert_manager_definition
- Retrieves the full information about the alert manager definition for a workspace
- describe_logging_configuration
- Returns complete information about the current logging configuration of the workspace
- describe_rule_groups_namespace
- Returns complete information about one rule groups namespace
- describe_scraper
- The DescribeScraper operation displays information about an existing scraper
- describe_workspace
- Returns information about an existing workspace
- get_default_scraper_configuration
- The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you
- list_rule_groups_namespaces
- Returns a list of rule groups namespaces in a workspace
- list_scrapers
- The ListScrapers operation lists all of the scrapers in your account
- list_tags_for_resource
- The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource
- list_workspaces
- Lists all of the Amazon Managed Service for Prometheus workspaces in your account
- put_alert_manager_definition
- Updates an existing alert manager definition in a workspace
- put_rule_groups_namespace
- Updates an existing rule groups namespace within a workspace
- tag_resource
- The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource
- untag_resource
- Removes the specified tags from an Amazon Managed Service for Prometheus resource
- update_logging_configuration
- Updates the log group ARN or the workspace ID of the current logging configuration
- update_workspace_alias
- Updates the alias of an existing workspace