Skip to content

Put Rule Groups Namespace

prometheusservice_put_rule_groups_namespace R Documentation

Updates an existing rule groups namespace within a workspace

Description

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.

The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.

Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use create_rule_groups_namespace.

You can't use this operation to add tags to an existing rule groups namespace. Instead, use tag_resource.

Usage

prometheusservice_put_rule_groups_namespace(workspaceId, name, data,
  clientToken)

Arguments

workspaceId

[required] The ID of the workspace where you are updating the rule groups namespace.

name

[required] The name of the rule groups namespace that you are updating.

data

[required] The new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file.

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

clientToken

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

Value

A list with the following syntax:

list(
  name = "string",
  arn = "string",
  status = list(
    statusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|"UPDATE_FAILED",
    statusReason = "string"
  ),
  tags = list(
    "string"
  )
)

Request syntax

svc$put_rule_groups_namespace(
  workspaceId = "string",
  name = "string",
  data = raw,
  clientToken = "string"
)