List Rule Groups Namespaces

prometheusservice_list_rule_groups_namespaces

R Documentation

Returns a list of rule groups namespaces in a workspace¶

Description¶

Returns a list of rule groups namespaces in a workspace.

Usage¶

prometheusservice_list_rule_groups_namespaces(maxResults, name,
  nextToken, workspaceId)

Arguments¶

maxResults

The maximum number of results to return. The default is 100.

name

Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.

nextToken

The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

For example, if your initial request has maxResults of 10, and there are 12 rule groups namespaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 namespaces.

workspaceId

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

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  ruleGroupsNamespaces = list(
    list(
      arn = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      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$list_rule_groups_namespaces(
  maxResults = 123,
  name = "string",
  nextToken = "string",
  workspaceId = "string"
)