Update Workspace Configuration

prometheusservice_update_workspace_configuration

R Documentation

Use this operation to create or update the label sets, label set limits, and retention period of a workspace¶

Description¶

Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the request to be valid.

Usage¶

prometheusservice_update_workspace_configuration(clientToken,
  limitsPerLabelSet, retentionPeriodInDays, workspaceId)

Arguments¶

clientToken

You can include a token in your operation to make it an idempotent opeartion.

limitsPerLabelSet

This is an array of structures, where each structure defines a label set for the workspace, and defines the ingestion limit for active time series for each of those label sets. Each label name in a label set must be unique.

retentionPeriodInDays

Specifies how many days that metrics will be retained in the workspace.

workspaceId

[required] The ID of the workspace that you want to update. To find the IDs of your workspaces, use the list_workspaces operation.

Value¶

A list with the following syntax:

list(
  status = list(
    statusCode = "ACTIVE"|"UPDATING"|"UPDATE_FAILED",
    statusReason = "string"
  )
)

Request syntax¶

svc$update_workspace_configuration(
  clientToken = "string",
  limitsPerLabelSet = list(
    list(
      labelSet = list(
        "string"
      ),
      limits = list(
        maxSeries = 123
      )
    )
  ),
  retentionPeriodInDays = 123,
  workspaceId = "string"
)