Skip to content
AWS for Query.Farm

aws.grafana.list_workspaces

Example SQL Queries

SELECT * FROM
aws.grafana.list_workspaces;

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 DescribeWorkspace.

Table Definition

Column NameColumn Data Type
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
authentication

A structure containing information about the authentication methods used in the workspace.

STRUCT(
    "providers" VARCHAR[],
    "saml_configuration_status" VARCHAR
)
Show child fields
authentication.providers[]
authentication.saml_configuration_status

Specifies whether the workplace's user authentication method is fully configured.

created

The date that the workspace was created.

TIMESTAMP_S
description

The customer-entered description of the workspace.

VARCHAR
endpoint

The URL endpoint to use to access the Grafana console in the workspace.

VARCHAR
grafana_token

The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.

VARCHAR
grafana_version

The Grafana version that the workspace is running.

VARCHAR
id

The unique ID of the workspace.

VARCHAR
license_type

Specifies whether this workspace has a full Grafana Enterprise license.

Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

VARCHAR
modified

The most recent date that the workspace was modified.

TIMESTAMP_S
name

The name of the workspace.

VARCHAR
notification_destinations

The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.

VARCHAR[]
Show child fields
notification_destinations[]
status

The current status of the workspace.

VARCHAR
tags

The list of tags associated with the workspace.

MAP(VARCHAR, VARCHAR)