Skip to content

Describe Workspace

prometheusservice_describe_workspace R Documentation

Returns information about an existing workspace

Description

Returns information about an existing workspace.

Usage

prometheusservice_describe_workspace(workspaceId)

Arguments

workspaceId

[required] The ID of the workspace to describe.

Value

A list with the following syntax:

list(
  workspace = list(
    alias = "string",
    arn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    kmsKeyArn = "string",
    prometheusEndpoint = "string",
    status = list(
      statusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"
    ),
    tags = list(
      "string"
    ),
    workspaceId = "string"
  )
)

Request syntax

svc$describe_workspace(
  workspaceId = "string"
)