Skip to content

Describe Rule Groups Namespace

prometheusservice_describe_rule_groups_namespace R Documentation

Returns complete information about one rule groups namespace

Description

Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use list_rule_groups_namespaces.

Usage

prometheusservice_describe_rule_groups_namespace(name, workspaceId)

Arguments

name

[required] The name of the rule groups namespace that you want information for.

workspaceId

[required] The ID of the workspace containing the rule groups namespace.

Value

A list with the following syntax:

list(
  ruleGroupsNamespace = list(
    arn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    data = raw,
    modifiedAt = as.POSIXct(
      "2015-01-01"
    ),
    name = "string",
    status = list(
      statusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|"UPDATE_FAILED",
      statusReason = "string"
    ),
    tags = list(
      "string"
    )
  )
)

Request syntax

svc$describe_rule_groups_namespace(
  name = "string",
  workspaceId = "string"
)