paws (version 0.4.0)

prometheusservice: Amazon Prometheus Service

Description

Amazon Managed Service for Prometheus

Usage

prometheusservice(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

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.

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.

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	Create an alert manager definition
create_logging_configuration	Create logging configuration
create_rule_groups_namespace	Create a rule group namespace
create_workspace	Creates a new AMP workspace
delete_alert_manager_definition	Deletes an alert manager definition
delete_logging_configuration	Delete logging configuration
delete_rule_groups_namespace	Delete a rule groups namespace
delete_workspace	Deletes an AMP workspace
describe_alert_manager_definition	Describes an alert manager definition
describe_logging_configuration	Describes logging configuration
describe_rule_groups_namespace	Describe a rule groups namespace
describe_workspace	Describes an existing AMP workspace
list_rule_groups_namespaces	Lists rule groups namespaces
list_tags_for_resource	Lists the tags you have assigned to the resource
list_workspaces	Lists all AMP workspaces, including workspaces being created or deleted
put_alert_manager_definition	Update an alert manager definition
put_rule_groups_namespace	Update a rule groups namespace
tag_resource	Creates tags for the specified resource
untag_resource	Deletes tags from the specified resource
update_logging_configuration	Update logging configuration
update_workspace_alias	Updates an AMP workspace alias

Examples

if (FALSE) {
svc <- prometheusservice()
svc$create_alert_manager_definition(
  Foo = 123
)
}