Skip to content

List Workspaces

managedgrafana_list_workspaces R Documentation

Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace

Description

Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use describe_workspace.

Usage

managedgrafana_list_workspaces(maxResults, nextToken)

Arguments

maxResults

The maximum number of workspaces to include in the results.

nextToken

The token for the next set of workspaces to return. (You receive this token from a previous list_workspaces operation.)

Value

A list with the following syntax:

list(
  nextToken = "string",
  workspaces = list(
    list(
      authentication = list(
        providers = list(
          "AWS_SSO"|"SAML"
        ),
        samlConfigurationStatus = "CONFIGURED"|"NOT_CONFIGURED"
      ),
      created = as.POSIXct(
        "2015-01-01"
      ),
      description = "string",
      endpoint = "string",
      grafanaToken = "string",
      grafanaVersion = "string",
      id = "string",
      licenseType = "ENTERPRISE"|"ENTERPRISE_FREE_TRIAL",
      modified = as.POSIXct(
        "2015-01-01"
      ),
      name = "string",
      notificationDestinations = list(
        "SNS"
      ),
      status = "ACTIVE"|"CREATING"|"DELETING"|"FAILED"|"UPDATING"|"UPGRADING"|"DELETION_FAILED"|"CREATION_FAILED"|"UPDATE_FAILED"|"UPGRADE_FAILED"|"LICENSE_REMOVAL_FAILED"|"VERSION_UPDATING"|"VERSION_UPDATE_FAILED",
      tags = list(
        "string"
      )
    )
  )
)

Request syntax

svc$list_workspaces(
  maxResults = 123,
  nextToken = "string"
)