Use this operation to return information about the configuration of a workspace¶

Description¶

Use this operation to return information about the configuration of a workspace. The configuration details returned include workspace configuration status, label set limits, and retention period.

Usage¶

prometheusservice_describe_workspace_configuration(workspaceId)

Arguments¶

workspaceId

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

Value¶

A list with the following syntax:

list(
  workspaceConfiguration = list(
    status = list(
      statusCode = "ACTIVE"|"UPDATING"|"UPDATE_FAILED",
      statusReason = "string"
    ),
    limitsPerLabelSet = list(
      list(
        limits = list(
          maxSeries = 123
        ),
        labelSet = list(
          "string"
        )
      )
    ),
    retentionPeriodInDays = 123,
    outOfOrderTimeWindowInSeconds = 123,
    ruleQueryOffsetInSeconds = 123
  )
)

Request syntax¶

svc$describe_workspace_configuration(
  workspaceId = "string"
)